id2

the ID converter that can convert between IDs with different orders and character types and unique numeric sequences.

install

1npm install @kanamone/id2

or

1yarn add @kanamone/id2

example

Human Readable ID

Instantiate

1const id2 = new ID2.Converter({
2  format: ID2.Converter.format('XXXX-00000', {
3    X: 'ACFHJKPRSTUVWXYZ',
4    0: '234567'
5  })
6})

Convert number to string

1id2.stringify(0)
2// => 'AAAA-22222'
3id2.stringify(1)
4// => 'AAAA-22223'
5id2.stringify(1234567)
6// => 'AATY-65553'
7id2.stringify(id2.numberOfAvailableIDs - BigInt(1))
8// => 'ZZZZ-77777'

Convert string to number

1id2.parse('AAAA-22222')
2// => 0n
3id2.parse('AAAA-22223')
4// => 1n
5id2.parse('AATY-65553')
6// => 1234567n
7id2.parse('ZZZZ-77777')
8// => 509607935n

UUID v4

Instantiate

1import ID2 from '@kanamone/id2'
2const id2 = new ID2.Converter({
3  format: ID2.Converter.format('RRRRRRRR-RRRR-4RRR-rRRR-RRRRRRRRRRRR', {
4    R: '0123456789abcdef',
5    r: '89ab'
6  })
7})

Convert number to string

1id2.stringify(0)
2// => '00000000-0000-4000-8000-000000000000'
3id2.stringify(BigInt('3881947731413173145134900932847109277'))
4// => 'bae8b334-a84b-4d25-ba49-3b943cfc849d'
5id2.stringify(id2.numberOfAvailableIDs - BigInt(1))
6// => 'ffffffff-ffff-4fff-bfff-ffffffffffff'

Convert string to number

1id2.parse('00000000-0000-4000-8000-000000000000')
2// => 0n
3id2.parse(BigInt('3881947731413173145134900932847109277'))
4// => 3881947731413173145134900932847109277n
5id2.parse('ffffffff-ffff-4fff-bfff-ffffffffffff')
6// => 5316911983139663491615228241121378303n

classes

class Converter

new Converter (options: Options)

Options

format

for ID pattern [A-Z]{3}-[0-9]{4}

1new ID2.Converter({
2  format: [
3    {
4      characters: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
5      repeats: 3
6    },
7    {
8      characters: '-',
9    },
10    {
11      characters: '0123456789',
12      repeats: 4
13    }
14  ]
15})

Or use the more manageable pattern helper.

1// Same format as above.
2new ID2.Converter({
3  format: ID2.Converter.format('XXX-0000', {
4    X: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
5    0: '0123456789'
6  })
7}

stringify (n: number | bigint): string

Converts the given number to a string.

parse (id: string): bigint

Converts the given id to a number.

lengthOfID: number

ID length specified by format.

numberOfAvailableIDs: number

Maximum number of IDs specified by format.

license

MIT