mcollina/hyperid

hyperid

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

crypto.randomUUID x 35,347,606 ops/sec ±0.86% (93 runs sampled)
hashids process.hrtime x 830,101 ops/sec ±0.51% (95 runs sampled)
hashids counter x 1,657,048 ops/sec ±0.86% (90 runs sampled)
shortid x 1,391,482 ops/sec ±0.74% (95 runs sampled)
crypto.random x 1,358,283 ops/sec ±0.51% (95 runs sampled)
nid x 1,776,272 ops/sec ±0.52% (98 runs sampled)
uuid.v4 x 21,321,246 ops/sec ±0.64% (94 runs sampled)
napiRsUuid.v4 x 9,432,514 ops/sec ±0.54% (95 runs sampled)
uuid.v1 x 1,221,798 ops/sec ±0.52% (97 runs sampled)
nanoid x 8,810,885 ops/sec ±1.09% (92 runs sampled)
hyperid - variable length x 62,811,243 ops/sec ±1.14% (93 runs sampled)
hyperid - fixed length x 61,866,636 ops/sec ±1.29% (93 runs sampled)
hyperid - fixed length, url safe x 62,014,823 ops/sec ±1.26% (93 runs sampled)
hyperid - max int x 99,237,132 ops/sec ±1.78% (89 runs sampled)

Fastest is hyperid - max int
Slowest is hashids process.hrtime

Note: Benchmark run with Apple M4 Max and Node.js v24.13.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 according to RFC4648. If { startFrom: <int> } is passed in, the first counter will start from that number, which must be between 0 and 2147483647. Fractions are discarded, only the integer part matters. If { maxInt: <int> } is passed in, the uuid will be re-generated once the maxInt is reached. The lesser the maxInt, higher the performance because of SMI (a V8 optimization).

instance()

Returns an unique id.

instance.uuid

The uuid used to generate the ids, it will change over time. If maxInt is provided in options, then it will regenerated every maxInt, else it will be 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