Class

SnowflakeUtil

Fluxer snowflake IDs (Twitter layout, custom epoch). Public API is string-only — never number — to avoid precision loss above 2^53.

Constructor

new SnowflakeUtil()

EPOCH: (readonly)

dateFromSnowflake(snowflake: Snowflake): Date

Date from a snowflake.

Param	Type	Description
snowflake	`Snowflake`

deconstruct(snowflake: Snowflake): DeconstructedSnowflake

Deconstruct a snowflake into timestamp / worker / process / increment.

Param	Type	Description
snowflake	`Snowflake`

isValid(snowflake: string): boolean

Whether `value` is a non-negative decimal snowflake string (≤ 20 digits).

Param	Type	Description
snowflake	`string`

parse(snowflake: Snowflake): bigint

Parse a snowflake string to bigint.

Param	Type	Description
snowflake	`Snowflake`

snowflakeFromTimestamp(timestamp: number): Snowflake

Snowflake string from a Unix timestamp (ms). Useful for pagination (`before` / `after`).

Param	Type	Description
timestamp	`number`

timestampFromSnowflake(snowflake: Snowflake): number

Unix timestamp (ms) from a snowflake.

Param	Type	Description
snowflake	`Snowflake`