Interface SnowflakeGenerateOptions

Options for Snowflake#generate

Hierarchy

  • SnowflakeGenerateOptions

Properties

increment? processId? timestamp? workerId?

Properties

Optional increment

increment?: bigint

The increment to use

Default

0n

Remark

keep in mind that this bigint is auto-incremented between generate calls

Optional processId

processId?: bigint

The process ID to use, will be truncated to 5 bits (0-31)

Default

1n

Optional timestamp

timestamp?: number | bigint | Date

Timestamp or date of the snowflake to generate

Default

Date.now()

Optional workerId

workerId?: bigint

The worker ID to use, will be truncated to 5 bits (0-31)

Default

0n

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc