Class default

SequenceFragment class for sequence (increment/counter) IDs.

Hierarchy

Constructors

constructor

Properties

bitMask bitMaskHex bitShift bits identifier maxValue value

Methods

destructure getValue resetSequence setBitShiftAndBitMask willReset

Constructors

constructor

  • Throws

    [BITS_INVALID_TYPE] If bits is not a number.

    Throws

    [BITS_INVALID_RANGE] If bits is less than 1

    Parameters

    • bits: number

      The number of bits for the fragment.

    Returns default

Properties

bitMask

bitMask: bigint

The bit mask used to isolate the fragment's bits from the snowflake.

bitMask is equal to maxValue << bitShift

bitMaskHex

bitMaskHex: string

The hexadecimal representation of the bit mask as string.

bitShift

bitShift: bigint

The number of bits for left and right shifting.

bitShift is equal to the number of bits on the right side

Readonly bits

bits: number

The number of bits for the fragment.

identifier

identifier: string

The fragment identifier.

Readonly maxValue

maxValue: bigint

The maximum value that can be represented by this fragment.

maxValue is equal to 2 ** bits - 1

value

value: bigint

The current value of the fragment.

Methods

destructure

  • Internal

    Returns a destructured fragment.

    Remarks

    Do not use this method outside of a Snowflakify instance.

    Returns

    A destructured fragment object with the following properties:

    • identifier: The identifier of the ID.
    • value: The value of the fragment for that snowflake.

    Parameters

    • snowflake: string | number | bigint

      The snowflake to destructure.

    Returns DestructuredFragment

getValue

resetSequence

setBitShiftAndBitMask

willReset

  • Internal

    Returns a boolean indicating whether the sequence will reset on the next call.

    Returns

    true if the sequence will reset when the next getValue() is called. Otherwise, returns false.

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc