A simple and customizable Snowflake ID generator for JavaScript and TypeScript projects, now with an additional random ID generation feature.
npm install @grkndev/snowflakeid
const { generateSnowflakeId, parseSnowflakeId, randomId } = require('@grkndev/snowflakeid');
// Generate a Snowflake ID with default options
const id = generateSnowflakeId();
console.log(id);
//=> '79796401721711616'
// Generate a Snowflake ID with custom options
const customId = generateSnowflakeId({ nodeId: 5, epoch: 1609459200000 });
console.log(customId);
// Parse a Snowflake ID
const parsedId = parseSnowflakeId(id);
console.log(parsedId);
// Generate a random ID
const randomID = randomId();
console.log(randomID);
//=> '283946'
// Generate a random ID with custom options
const customRandomID = randomId(8, { useChars: true, useNumbers: true });
console.log(customRandomID);
//=> 'a3Bf9x2Z'
import { generateSnowflakeId, parseSnowflakeId, SnowflakeOptions, randomId, RandomIdOptions } from '@grkndev/snowflakeid';
// Generate a Snowflake ID with default options
const id = generateSnowflakeId();
console.log(id);
// Generate a Snowflake ID with custom options
const options: SnowflakeOptions = { nodeId: 5, epoch: 1609459200000 };
const customId = generateSnowflakeId(options);
console.log(customId);
// Parse a Snowflake ID
const parsedId = parseSnowflakeId(id);
console.log(parsedId);
// Generate a random ID with default options
const randomID = randomId();
console.log(randomID);
// Generate a random ID with custom options
const randomOptions: RandomIdOptions = { useChars: true, useNumbers: true };
const customRandomID = randomId(8, randomOptions);
console.log(customRandomID);
Generates a Snowflake ID.
Options:
-
epoch
(optional): Custom epoch timestamp (in milliseconds since Unix epoch). Default is 1609459200000 (2021-01-01T00:00:00Z). -
nodeId
(optional): Node ID for distributed systems (0-1023). Default is 1. -
sequence
(optional): Initial sequence number (0-4095).
Returns a string representation of the generated Snowflake ID.
Parses a Snowflake ID into its component parts.
Parameters:
-
id
: The Snowflake ID to parse. -
epoch
(optional): The epoch used in ID generation. Default is 1609459200000 (2021-01-01T00:00:00Z).
Returns an object containing the parsed components of the Snowflake ID:
-
timestamp
: Date object representing the timestamp of ID generation. -
nodeId
: The node ID used in ID generation. -
sequence
: The sequence number used in ID generation.
Generates a random ID.
Parameters:
-
length
(optional): The length of the ID to generate. Default is 6. -
options
(optional): An object with the following properties:-
useChars
(optional): Whether to use alphabetic characters. Default is false. -
useNumbers
(optional): Whether to use numeric characters. Default is true.
-
Returns a string representation of the generated random ID.
The generateSnowflakeId
function may throw errors in the following cases:
- If the provided
nodeId
is less than 0 or greater than 1023. - If the provided
epoch
is a negative number or a future timestamp. - If the system clock moves backwards.
The randomId
function may throw an error if neither useChars
nor useNumbers
is set to true in the options.
MIT