phpMan > man > BSON::MinKey

NAME
    BSON::MinKey - BSON type wrapper for MinKey

VERSION
    version v1.12.2

SYNOPSIS
        use BSON::Types ':all';

        bson_minkey();

DESCRIPTION
    This module provides a BSON type wrapper for the special BSON "MinKey" type. The object returned
    is a singleton.

METHODS
  TO_JSON
    If the "BSON_EXTJSON" option is true, returns a hashref compatible with MongoDB's extended JSON
    <https://github.com/mongodb/specifications/blob/master/source/extended-json.rst> format, which
    represents it as a document as follows:

        {"$minKey" : 1}

    If the "BSON_EXTJSON" option is false, an error is thrown, as this value can't otherwise be
    represented in JSON.

AUTHORS
    *   David Golden <david AT mongodb.com>

    *   Stefan G. <minimalist AT 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