incremental-id-generator
v0.1.0 incremental id uid generator custom alphabet base encoding
incremental-id-generator
Generates incremental string IDs.
Installation
npm install incremental-id-generator --save-dev
Usage
const idGenerator = require('incremental-id-generator');
const nextID = idGenerator('ab');
nextID(); // -> a
nextID(); // -> b
nextID(); // -> aa
nextID(); // -> ab
nextID(); // -> ba
nextID(); // -> bb
nextID(); // -> aaa
nextID(); // -> aab
API
idGenerator(characters, [options]) ⇒ function
Returns a function that will return a new, incrementing ID each time it is called.
Param | Type | Description |
---|---|---|
characters | string | The characters that will be used to encode the ID. Must not contain duplicate characters. |
[options.prefix] | string | A prefix to prepend to every generated ID. |
Example
const idGenerator = require('incremental-id-generator');
const nextBinID = idGenerator('01');
nextBinID(); // -> 0
nextBinID(); // -> 1
nextBinID(); // -> 00
nextBinID(); // -> 01
const nextPrefixedID = idGenerator('abc', {prefix: '_'});
nextPrefixedID(); // -> _a
nextPrefixedID(); // -> _b
nextPrefixedID(); // -> _c
nextPrefixedID(); // -> _aa
nextPrefixedID(); // -> _ab
nextPrefixedID(); // -> _ac
nextPrefixedID(); // -> _ba
npm i incremental-id-generator
Metadata
- MIT
- >=4
- Nathan Woltman
- released 1/2/2017