@andrew_l/snowflake

Snowflake - Generate unique IDs in a distributed environment at scale

There is a bit improved version of @sapphire/snowflake package by using javascript numbers and Uint8Array buffer.

⚡ Benchmark

  name                               hz      rme   samples
· sapphire                10,690,009.83   ±0.62%  10690010
· andrew (bigint)         11,704,038.89   ±0.03%  11704039
· andrew (buffer)         13,808,748.82   ±0.37%  13808749
· andrew (buffer unsafe)  16,023,413.95   ±0.04%  16023414   fastest

🚀 Example Usage

Basic Example

import { Snowflake } from '@andrew_l/snowflake';

// Define a custom epoch
const epoch = 1751810749563;

// Create an instance of Snowflake
const snowflake = new Snowflake({ epoch });

// Generate a snowflake with the given epoch
const uniqueId = snowflake.generate();

// Generate a snowflake with the given epoch
const uniqueIdBuffer = snowflake.generateBuffer();

Stripe Style

import { Snowflake } from '@andrew_l/snowflake';
import { base62, bigIntFromBytes } from '@andrew_l/toolkit';

// Create an instance of Snowflake
const snowflake = new Snowflake({ epoch: 1288834974657 });

// Generate a snowflake with the given epoch
const customerId = 'cus_' + base62.encode(snowflake.generateBuffer());

// e.g. cus_2JRkp89kSZs
console.log('customer id  =', customerId);

// Extract the numeric value by decoding the base62 portion
const customerIdNumber = bigIntFromBytes(base62.decode(customerId.slice(4)));

// e.g. 1941863457523503104n
console.log('customer id (number) =', customerIdNumber);