Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including objectid-stub with all npm packages installed. Try it out:

var objectidStub = require("objectid-stub")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

objectid-stub v1.3.1

Create predictable ObjectIds

objectid-stub

Create predictable MongoDB like ObjectIds for testing purposes.

NPM version Build status Dependency Status devDependency Status Coverage Status Code Climate

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

_createObjectId(prefix, from, MyConstrutor)string | MyConstructor

Create an object id from the given number

objectIdStubInit(options)function

Instanciate a new object id generator

## _createObjectId(prefix, from, MyConstrutor) ⇒ string | MyConstructor Create an object id from the given number

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

ParamTypeDescription
prefixString12 chars string to prefix the id with
fromNumberNumber from wich to create the id
MyConstrutorfunctionA 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

ParamTypeDescription
optionsObjectGenerator options
options.ctorfunctionAllow to specify a custom constructor)
options.prefixStringAllow to create object id with the given 12 chars prefix

objectIdStubInit~getNextObjectId() ⇒ String

Generate the next id

Kind: inner method of objectIdStubInit
Returns: String - The generated id
Api: public

getNextObjectId.next(n) ⇒ String

Lookup what will be the next id

Kind: static method of getNextObjectId
Returns: String - The next id
Api: public

ParamTypeDescription
nNumberNumber of ids to discard (defaults to 0)

getNextObjectId.reset() ⇒ void

Reset the internal id

Kind: static method of getNextObjectId
Api: public

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free