Documents for @litert/uuid / Snowflake / SnowflakeGenerator
Class: SnowflakeGenerator
Defined in: Snowflake.ts:27
The class for generating Snowflake IDs.
Constructors
Constructor
new SnowflakeGenerator(
options):SnowflakeGenerator
Defined in: Snowflake.ts:66
Parameters
options
Returns
SnowflakeGenerator
Properties
epoch
readonlyepoch:number
Defined in: Snowflake.ts:58
The epoch of the generator.
The value is recommended to be the time when the service/application goes online.
Default
0machineId
readonlymachineId:number
Defined in: Snowflake.ts:49
The identifier of the machine that generates the UUID.
For the snowflake ID of a specific resource, each generator must use a unique machine ID so that the generated IDs will not conflict with each other.
Range
0 - 1023
MAX_MACHINE_ID
readonlystaticMAX_MACHINE_ID:1023=1023
Defined in: Snowflake.ts:39
The maximum machine ID that can be used by the generator.
MIN_MACHINE_ID
readonlystaticMIN_MACHINE_ID:0=0
Defined in: Snowflake.ts:33
The minimum machine ID that can be used by the generator.
Methods
generate()
generate():
bigint
Defined in: Snowflake.ts:102
Generate the next Snowflake ID, based on the current time and the next sequence number.
Returns
bigint
A Snowflake ID, which is a 64-bit integer (BigInt).
Throws
If the current time is earlier than the previous time.
Throws
If the sequence number exceeds the maximum value.
Throws
If the current time is before the epoch.
generateBy()
generateBy(
timestamp,sequence):bigint
Defined in: Snowflake.ts:142
Generate a Snowflake ID by specifying the timestamp and sequence number.
Parameters
timestamp
number
The timestamp to use for the ID.
sequence
number
The sequence number to use for the ID (0 ~ 4095).
Returns
bigint
A Snowflake ID, which is a 64-bit integer (BigInt).
Throws
If the sequence number exceeds the maximum value.
Throws
If the timestamp is before the epoch.