hyperid

Uber-fast unique id generation, for Node.js and the browser. Here are the benchmarks:

hashids process.hrtime x 161,779 ops/sec ±3.25% (78 runs sampled)
hashids counter x 327,099 ops/sec ±2.45% (76 runs sampled)
shortid x 26,225 ops/sec ±3.90% (72 runs sampled)
nid x 864,834 ops/sec ±2.94% (83 runs sampled)
uuid.v4 x 269,960 ops/sec ±2.42% (81 runs sampled)
uuid.v1 x 1,687,472 ops/sec ±1.38% (85 runs sampled)
hyperid - variable length x 6,121,953 ops/sec ±2.66% (76 runs sampled)
hyperid - fixed length x 6,331,137 ops/sec ±2.31% (79 runs sampled)

Note: Benchmark run with 1,3 GHz Intel Core i5 using Node v8.10.0

Install

npm i hyperid --save

Example

'use strict'

const hyperid = require('hyperid')
const instance = hyperid()

const id = instance()

console.log(id)
console.log(instance())
console.log(hyperid.decode(id))
console.log(hyperid.decode(instance()))

API

hyperid([fixedLength || options])

Returns a function to generate unique ids.
The function can accept one of the following parameters:

fixedLength: Boolean
If fixedLength is true the function will always generate an id that is 33 characters in length, by default fixedLength is false.
options: Object
If { fixedLength: true } is passed in, the function will always generate an id that is 33 characters in length, by default fixedLength is false.
If { urlSafe: true } is passed in, the function will generate url safe ids.

instance()

Returns an unique id.

instance.uuid

The uuid used to generate the ids, it will change over time. It is regenerated every Math.pow(2, 31) - 1 to keep the integer a SMI (a V8 optimization).

hyperid.decode(id, [options])

Decode the unique id into its two components, a uuid and a counter.
If you are generating url safe ids, you must pass { urlSafe: true } as option.
It returns:

{
  uuid: '049b7020-c787-41bf-a1d2-a97612c11418',
  count: 1
}

This is aliased as instance.decode.

License

MIT

dimfeld / hyperid