README
unique-number
Generate a unique number.
Basically, a simple iterator/counter. Optionally, use timestamps.
After many generations—typically when your operations are complete—it'd be a good idea to run reset()
to avoid going beyond Number.MAX_SAFE_INTEGER
.
var UniqueNumber = require("unique-number");
var uniqueNumber = new UniqueNumber();
console.log( uniqueNumber.generate() ); //-> 0
console.log( uniqueNumber.generate() ); //-> 1
uniqueNumber.reset();
console.log( uniqueNumber.generate() ); //-> 0
Timestamps:
var uniqueNumber = new UniqueNumber(true);
console.log( uniqueNumber.generate() ); //-> 1430000000000
console.log( uniqueNumber.generate() ); //-> 1430000000001
console.log( uniqueNumber.generate() ); //-> 1430000000002
uniqueNumber.reset();
console.log( uniqueNumber.generate() ); //-> 1430000000000
setTimeout( function() {
console.log( uniqueNumber.generate() ); //-> 1430000000100
}, 100);
Shortcut syntax:
var uniqueNumber = require("unique-number")();
When using timestamps, the value is simply iterated when multiple requests are made per millisecond.
Notice
This library does not attempt to go beyond its simple design. If you need something more elaborate, check out cuid, puid or shortid.