incremental-id-generator v0.1.0

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.

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