numerator
A simple script, that increments serial numbers, containing non-digit symbols
Useful for numbering documents, catalogs, users and etc.
Quickstart
npm install numerator
Then make reference inside yor module...
const numerator = ; // ... start numeration from begining with given templatenumeratornext'IN/2019/000'; // ⇨ 'IN/2019/001' // ... or to get next of the given numbernumeratornext'IN/2019/056'; // ⇨ 'IN/2019/057' // ... to get first number with only given prefixnumeratornext'USER-' true; // ⇨ 'USER-1' // ... or to get next number with expanding templatenumeratornext'USER-99' true; // ⇨ 'USER-100'
API
next(num, [expand])
Generates and returns next number based on given number
Arguments
num
- (string | number) A number, that must be icrementedexpand
- (boolen) optional;true
, if we want to expand number template (to increase its lenght) in case, when quantity of digits of the number must be increased; by default it isfalse
Note: if you pass "USER-99" as num
and expand
is false
, it will throw Error (not returns "USER-100"), so if you need "USER-100", expand
mast be true
Returns
string
- result of inrementing
getPrefix(num)
Returns the prefix of given number
Arguments
num
- (string | number) A number, we want to get prefix of
Returns
string
- prefix of the number, if the number has it
Note: prefix will be returned without leading zeros, if the number has them
Testing
npm test