BSON::MaxKey(3pm)

💖 BSON::MaxKey 💖

ok bestie, welcome to BSON::MaxKey, the Perl manual page for the BSON type wrapper for MaxKey — yes, that's the whole vibe, it's a tiny little legend and we're obsessed 💅

This page lives in the User Contributed Perl Documentation section, so you already know it's giving community-crafted excellence ✨

✨ VERSION ✨

version v1.12.2 🎀

✨ SYNOPSIS ✨

okay so here's literally all you gotta do:

use BSON::Types ':all';

bson_maxkey();

that's it. that's the whole thing. slay 🌸

✨ DESCRIPTION ✨

so this module hands you a BSON type wrapper for the special BSON "MaxKey" type 💜 and here's the cute part: the object you get back is a singleton 👑 — like, there's only ever one of it, main character energy fr fr, no cap.

✨ METHODS ✨

TO_JSON

okay so this one's conditional, pay attention bestie 🫶

• If the BSON_EXTJSON option is true, you get back a hashref that's compatible with MongoDB's extended JSON format — that's the spec over at https://github.com/mongodb/specifications/blob/master/source/extended-json.rst — and it represents the thing as a document like this:

{"$maxKey" : 1}

• If the BSON_EXTJSON option is false, an error is thrown, because this value literally cannot be represented in JSON any other way 😭 that's not a vibe, that's just the rules.

⚠️ heads up: flip that BSON_EXTJSON flag off and it's not gonna shrug and give you something cute — it throws. periodt.

---

✨ AUTHORS ✨

the icons who made this happen 🫶

• David Golden <david@mongodb.com>
• Stefan G. <minimalist@lavabit.com>

✨ COPYRIGHT AND LICENSE ✨

This software is Copyright (c) 2020 by Stefan G. and MongoDB, Inc. 🌈

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

---

and that's the whole page bestie, tysm for reading 💖 this was BSON::MaxKey, rendered by perl v5.30.3 and dated 2020-08-14 — love that for us, see you in the next manpage, mwah 🎀✨