npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@rockerapp/flake

v2.1.1

Published

Time-based, unique 64-bit ID generator, inspired by Twitter's Snowflake

Downloads

11

Readme

Flake

A module to generate time-based 64-bit unique IDs, inspired by Twitter's Snowflake ID system.

Flake is generated by concatenating:

  • a 42-bit timestamp,
  • a 10-bit node ID (or any random number you provide), and
  • a 12-bit sequential number.

Because of JavaScript's 53-bit integer precision limit, Flake generates a BigInt like 285124269753503744n, which can be easily be type-cast as a 64-bit bigint in a database.

Usage

Initialize

import Flake from '@rockerapp/flake'

// initialize Flake instance
// all settings are optional
const flake = new Flake({
	nodeId: 42, // optional, define machine ID
	timeOffset: (2020-1970)*31536000*1000 // optional, define a time offset
})

Create a instance of Flake as shown above, which will be used to generate IDs afterward.

Generate ID

const id1 = flake.generate() // returns something like 285124269753503744n
const id2 = flake.generate() // returns something like 285124417543999488n

Options

nodeId (number, default: 1)

A machine ID or any random number. If you are generating IDs on multiple nodes, it's highly advised to pass a proper node ID that is unique to the machine.


timeOffset (number, default: 0)

Time to be subtracted from current timestamp (based on the Unix epoch) to determine the first 42 bits of ID.

Functions

generate() (string)

Returns a stringified generateRaw() output.


generateRaw() (BigInt)

Generates an ID based on the options passed to the Flake instance.

License

Flake is distributed under the MIT license. Originally created by Sudhanshu Yadav, with help from other contributors.

See LICENSE file for license text.