Objectid-stub NPM

objectid-stub

Create predictable MongoDB like ObjectIds for testing purposes.

Under production, you can simply use the NodeJS MongoDB Native Driver ObjectID constructor, in your test òbjectid-stub makes new ObjectIds creation predictable.

Usage

var initObjectIdStub = require('objectid-stub');
var ObjectId = require('mongo/objectid');
var objectIdStub = initObjectIdStub();

objectIdStub();
// '570b570b570bffffffffffff'

objectIdStub.next();
// '570b570b570bfffffffffffe'

objectIdStub.next(3);
// '570b570b570bfffffffffffb'

objectIdStub();
// '570b570b570bfffffffffffe'
objectIdStub();
// '570b570b570bfffffffffffd'
objectIdStub();
// '570b570b570bfffffffffffc'
objectIdStub();
// '570b570b570bfffffffffffb'

objectIdStub.reset();

objectIdStub();
// '570b570b570bffffffffffff'

objectIdStub = initObjectIdStub({ ctor: ObjectId });

objectIdStub();
// ObjectID('570b570b570bffffffffffff')

API Functions

Kind: global function
Returns: string | MyConstructor - The object id in a string/MyConstructor representation
Api: private

Param	Type	Description
prefix	String	12 chars string to prefix the id with
from	Number	Number from wich to create the id
MyConstrutor	function	A constructor to build ObjectId instances (default to strings)

objectIdStubInit(options) ⇒ function

Instanciate a new object id generator

Kind: global function
Returns: function - The new generator
Api: public

Param	Type	Description
options	Object	Generator options
options.ctor	function	Allow to specify a custom constructor)
options.prefix	String	Allow to create object id with the given 12 chars prefix