niknik-uniqueid
v0.1.1
Published
Generate a unique sequential ID. Optionally pass a prefix, suffix, or multiplier.
Downloads
3
Maintainers
Readme
uniqueid
Generate a unique sequential ID. Optionally pass a prefix, suffix, or multiplier.
Install
Install with npm:
npm i uniqueid --save-dev
Run tests
npm test
Usage
var uniqueId = require('uniqueid');
console.log(uniqueId('abc'));
//=> ['a', 'b', 'c'];
API
id
Generate a unique ID.
options
{Object}: Optionally pass aprefix
,suffix
and/or `multiplier.returns
{String}: The unique id.
Optionally pass a prefix to prepend, a suffix to append, or a multiplier to use on the ID.
uniqueId(); //=> '25'
uniqueId({prefix: 'apple_'});
//=> 'apple_10'
uniqueId({suffix: '_orange'});
//=> '10_orange'
uniqueId({multiplier: 5});
//=> 5, 10, 15, 20...
To reset the id
to zero, do id.reset()
.
Author
Jon Schlinkert
License
Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license
This file was generated by verb-cli on September 14, 2014.