JSON::...:Syntax(3pm)

📦
version 0.07 · 4 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

👑 JSON::Pointer::Syntax — the manual page, but make it cute

okay so first things first: this is a page from the User Contributed Perl Documentation (you know, the perl man pages that ship with the vibes), and the module in question is JSON::Pointer::Syntax. 💖

✨ NAME ✨

JSON::Pointer::Syntax — JSON Pointer syntax functions. literally what it says on the tin, bestie. 🎀

🌸 VERSION 🌸

This document describes JSON::Pointer::Syntax version 0.07. yes, zero point zero seven. it's giving vintage. it's giving classic. we love her. 💅

🦋 SYNOPSIS 🦋

not me checking the synopsis and finding… absolutely nothing. 🙈 the SYNOPSIS section is empty in the original. no code block, no example, nada. she said "figure it out." iconic behaviour, honestly.

💜 DESCRIPTION 💜

This module is internal only. 🚫

that's it. that's the whole description. it's not for you, it's not for me, it's for the module's own little ecosystem. do not perceive her. 🫶

🔥 FUNCTIONS 🔥

here's the lineup, no cap. heads up though: the original page just lists these signatures and does not describe what each one does — so I'm not gonna make anything up, I'm just gonna present them pretty. 😌

⭐ escape_reference_token($unescaped_reference_token :Str) :Str

takes an $unescaped_reference_token that's a Str, hands you back a Str. ✨

⭐ unescape_reference_token($escaped_reference_token :Str) :Str

takes an $escaped_reference_token that's a Str, hands you back a Str. the reverse energy of the one above, name-wise. 🦋

⭐ tokenize($pointer :Str) : Array/ArrayRef

takes a $pointer that's a Str, and gives you back an Array / ArrayRef. yes, both. she contains multitudes. 💅

⭐ as_pointer(\@tokens) :Str

takes a reference to an array of tokens (\@tokens), and returns a Str. 🎀

⭐ is_array_numeric_index($token) :Int

takes a $token and returns an Int. that's the whole signature, bestie, no notes. 🌸

🌈 DEPENDENCIES 🌈

you're gonna need Perl 5.8.1 or later. no ancient perl, she has standards. 👑

💀 BUGS 💀

All complex software has bugs lurking in it, and this module is no exception. 😭 fr fr, every codebase has a little gremlin hiding in it somewhere.

If you find a bug, please either:

  • email me, or
  • add the bug to cpan-RT.

that's the whole protocol. do your civic duty. 🫡

🌟 SEE ALSO 🌟

  • perl
  • Class::Accessor::Lite

go read those too, iykyk. 📚✨

💖 AUTHOR 💖

Toru Yamaguchi <zigorou at cpan.org> — shoutout to the author, absolute main character. 👑

Copyright (c) 2013, Toru Yamaguchi. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. 💅

k that's the whole page, bestie. every option, every signature, every copyright line — nothing dropped, nothing invented. we ate and left no crumbs. 🍓

and for the cute sign-off: this page came to you via perl v5.34.0, dated 2022-06-15, filed under JSON::...:Syntax(3pm). periodt. 💜

📦 where this page comes from