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

instauuid

v1.0.4

Published

Instagram-style UUID Generator for Node

Downloads

1

Readme

InstaUUID

NPM Version Node.js Version NPM Downloads

See Instagram Engineering Blog - Sharding IDs at Instagram

Instagram-Style Compact UUID generator for Node.js.

Generates 8-byte UUID that consists of:

  • 41 bits for time in milliseconds (we can use it until 2084/09/06 lunch time comes)
  • 13 bits for additional information - Instagram used it to store the logical shard ID
  • 10 bits that represent an auto-incrementing sequence.
  • Note that you need to implement your own counter per machine - In default, we fillthis space with random values.

Benefits of this library:

  • Qualified - Because this library implements Instagram UUID Spec. and instagram rocks.
  • Compact Size - The raw hash is only 8bytes, and Base64 hash is only 11 bytes!
  • URL-Safe - The default Base64 encoding does not contain URL-non-safe characters.

Installation

$ npm install --save instauuid

Examples

var instauuid = require('instauuid');

instauuid(); // Default: Base64 - ex) "paZhL98FBXs"
instauuid('hex'); // Hex String - ex) "a5afe16d768b4cdf"
instauuid('decimal'); // Decimal String - ex) "11939009410687035132"

// Using InstaUUID with MySQL
// See "Integrating with your database" Section.
var sql = 'INSERT INTO users (id, name) VALUES (??, ??)';
sql = mysql.format(instauuid('decimal'), 'John Doe');

// You can add some information to prevent hash conflicts. (recommended for big systems)
instauuid({ type: 'hex', additional: shardId, countNumber: 1022 });

Integrating with your database

MySQL

First, You need to set your primary key datatype to UNSIGNED BIGINT.

CREATE TABLE foo (
   id   BIGINT UNSIGNED NOT NULL UNIQUE PRIMARY KEY,
   ....
);

#####node-mysql Driver

  • Set 'supportBigNumbers', 'bigNumberStrings' options to true when connecting.
  • This option makes you to read BIGINT as String, because UUID is too big thatJavaScript Number type cannot support. Number can handle up to 2^53 but we're using 2^64 range (Unsigned Int64)
  • I recommend to use Long or bignumber.js Library when handling BIGINT data.
  • Use 'decimal' type when generating UUID. (See above example)

Redis

Redis stores Integer as String, so you don't need to worry about anything.

MongoDB

Just use MongoDB ObjectId.

Documentation

instauuid(options)

Generates and returns UUID.

  • options (object || string): Generating options. (or return type)

Option | Description | Range | Default ------- | ------------------------------------------------------------ | ---- | ------ type | Return type of generated ID. See below for more details. | - | 'base64' additional | Additional Unique Information (ex: Logical Shard ID) | 0 ~ 8191 | (current time as μs) countNumber | Auto-incrementing sequence - to prevent conflicting | 0 ~ 1023 | (Random)

Return types

Name | Description | Type | ---------| --- | --- | base64 | Base64 Hash (Note that this is not pure Base64. We uses URL-Safe Base64URL) | String | decimal | Decimal String | String | number | (Same as above) | - | hex | Hex String | String | hash | (Same as above) | - | long | Long object | Long | buffer | Buffer object | Buffer| buffer_be| Big-Endian encoded buffer | Buffer | raw | Raw ASCII Bytes - Don't recommend. | String |

License: MIT

Author: Hyojun Kim