This module allows you to create and parse ObjectID
s without a reference to the
mongodb or bson
modules.
The goal is to be 100% compatable with all bson's public API implementation (found here: https://github.com/mongodb/js-bson/blob/main/src/objectid.ts).
$ npm install bson-objectid
var ObjectID = require("bson-objectid");
console.log(ObjectID());
console.log(ObjectID("54495ad94c934721ede76d90"));
console.log(ObjectID(1414093117));//time
console.log(ObjectID([ 84, 73, 90, 217, 76, 147, 71, 33, 237, 231, 109, 144 ]));
console.log(ObjectID(new Buffer([ 84, 73, 90, 217, 76, 147, 71, 33, 237, 231, 109, 144 ])));
Creates a new immutable ObjectID
instance based on the current system time.
Possible arguments:
time Constructs the instance based on the specified time (in seconds).
hexString Constructs the instance from a 24 character hex string.
idString Constructs the instance from a 12 byte string.
array Constructs the instance from an Array
of 24 bytes.
buffer Constructs the instance from a 24 byte Buffer
instance.
returns the 12 byte id string.
returns the ObjectID
represented as a 24 character hex string.
returns true if the ObjectID
s represent the same underlying value. Otherwise false.
returns the generation Date
(accurate up to the second) that this ObjectID
was generated.
Creates an ObjectID from a time (in seconds) Number
, with the rest of the ObjectID
zeroed out. Used for comparisons or sorting the ObjectID.
Creates an ObjectID from a 24 character hex string.
Checks if a value is a valid ObjectID
or 24 character hex string.
THE NATIVE DOCUMENTATION ISN'T CLEAR ON THIS GUY!
See: http://mongodb.github.io/node-mongodb-native/api-bson-generated/objectid.html#objectid-isvalid
mocha
or
npm test
Apache v2.0
See LICENSE file.
Special callout to @feross for the is-buffer code used internally to avoid Buffer from being loaded in browserify environments.