SnowflakeUtil

Package: @erinjs/util

Utilities for erin.js snowflake IDs. erin.js uses Twitter Snowflakes with a custom epoch.

Properties

Name	Type	Readonly	Optional	Description
EPOCH	1420070400000n	Yes	No

Methods

dateFromSnowflake()

Converts a snowflake to a Date.

Returns: Date

Parameters:

Name	Type	Optional	Description
snowflake	string	No

---

deconstruct()

Deconstructs a snowflake into its components.

Returns: { timestamp: number; date: Date; workerId: number; processId: number; increment: number; }

Parameters:

Name	Type	Optional	Description
snowflake	string	No

---

isValid()

Checks if a string is a valid snowflake format (numeric string, 0 or positive).

Returns: boolean

Parameters:

Name	Type	Optional	Description
snowflake	string	No

---

snowflakeFromTimestamp()

Converts a Unix timestamp (ms) to a snowflake string. Useful for pagination (before/after).

Returns: string

Parameters:

Name	Type	Optional	Description
timestamp	number	No

---

timestampFromSnowflake()

Converts a snowflake to a Unix timestamp in milliseconds.

Returns: number

Parameters:

Name	Type	Optional	Description
snowflake	string	No