npm

Join us for the "JavaScript Supply Chain Security" tech talk, presented by VP of Security, Adam Baldwin. 6/20 at 10am PT.Sign up here »

node-flakes

1.0.0 • Public • Published

node-flakes

Build Status Coverage Status Version npm npm Downloads Dependencies

The Node identity lib that provides:

  • Coordination free
  • 128 bit keys
  • K-ordered
  • Lexicographically sortable
  • base 62

Break down

128 bit key comprised of the following:

{timestamp}{worker}{sequence}

  • 64 bit timestamp
  • 48 bit worker id
  • 16 bit sequence number

The sequence number increments for each subsequent id requested within the same millisecond.

API

require('node-flakes')

Requiring node-flakes returns a function. Even when required and executed multiple times the same instance gets returned. This is worth noting so that you don't have to go through extra effort to pass around the seed value or continue to re-initialize it every time.

Using MACAddress or HostName as seed

If no seed is provided, you can use seedFromEnvironment to use either the MAC address or host name plus the process id as the seed. This may not prevent duplicate seeds or id collisions, because of scenario where duplicate MACs or host names in your environment can occur.

const flakes = require('node-flakes')();
flakes.seedFromEnvironment() // this call returns a promise and can be awaited if in an async call
  .then(
    () => {
      const id = flakes.create(); // ta-da
    }
  );

Unique seeds

Anything can seed the node id. node-flakes uses farmhash to create a unique 32 bit integer from whatever you have lying around. This needs to be unique for every instance creating ids.

const flakes = require('node-flakes')('Hey, look, a (terrible) string based seed.');
const id = flakes.create(); // ta-da

Speed

Looks like this tops out around 20 / ms on modern processors. Do with that what you will :)

install

npm i node-flakes

Downloadsweekly downloads

0

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability