Need help with hyperid?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

mcollina
358 Stars 24 Forks MIT License 88 Commits 3 Opened issues

Description

Uber-fast unique id generation, for Node.js and the browser

Services available

!
?

Need anything else?

Contributors list

# 1,399
JavaScr...
node
nodejs-...
mqtt-br...
47 commits
# 318,429
JavaScr...
React N...
reactjs
mobx-st...
7 commits
# 5,104
JavaScr...
Node.js
TypeScr...
elastic...
5 commits
# 369,741
JavaScr...
TypeScr...
Shell
3 commits
# 89,482
HTML
Go
Express
Koa
2 commits
# 127,026
JavaScr...
Ember
CSS
dashboa...
2 commits
# 61,670
face-tr...
golang
Go
OpenCV
1 commit
# 82,526
Go
Svelte
sveltej...
jira
1 commit
# 679,288
JavaScr...
TypeScr...
1 commit
# 27,636
ecmascr...
repl
graphql...
control...
1 commit
# 87,939
GraphQL
js
Electro...
stringi...
1 commit
# 12,591
fastify
adafrui...
Rust
Deno
1 commit
# 222,810
HTML
Shell
depende...
Angular
1 commit
# 439,348
Shell
C
JavaScr...
1 commit

hyperid

Build Status

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

crypto.randomUUID x 17,421,022 ops/sec ±1.05% (92 runs sampled)
hashids process.hrtime x 381,775 ops/sec ±0.22% (95 runs sampled)
hashids counter x 730,949 ops/sec ±0.23% (97 runs sampled)
shortid x 34,682 ops/sec ±3.82% (83 runs sampled)
crypto.random x 313,547 ops/sec ±2.88% (82 runs sampled)
nid x 1,365,624 ops/sec ±0.07% (96 runs sampled)
uuid.v4 x 1,313,028 ops/sec ±0.10% (97 runs sampled)
napiRsUuid.v4 x 536,390 ops/sec ±0.20% (96 runs sampled)
uuid.v1 x 1,999,272 ops/sec ±0.09% (98 runs sampled)
nanoid x 3,808,014 ops/sec ±0.33% (95 runs sampled)
hyperid - variable length x 20,197,843 ops/sec ±0.74% (94 runs sampled)
hyperid - fixed length x 18,894,869 ops/sec ±0.12% (95 runs sampled)
hyperid - fixed length, url safe x 20,158,778 ops/sec ±0.54% (94 runs sampled)

Note: Benchmark run with Intel(R) Core(TM) i7-7700 CPU @ 3.60GHz and Node.js v16.3.0

As you can see the native

crypto.randomUUID
is almost as fast as hyperid on Node.js v16, but not on v14.

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:  }
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.

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.