Class default

WorkerFragment class for worker IDs.

Hierarchy

  • default
    • default

Constructors

constructor

Properties

bitMask bitMaskHex bitShift bits identifier maxValue value

Methods

destructure getValue getWorkerId setBitShiftAndBitMask updateId

Constructors

constructor

  • Throws

    [VALUE_INVALID_TYPE] If value is not a number.

    Throws

    [VALUE_INVALID_RANGE] If value is not within 0 and 2 ** bits - 1

    Parameters

    • bits: number

      The number of bits for the fragment.

    • Optional value: number

      A persistent ID value to use for the fragment.

      Defaults to the current worker ID if omitted.

    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

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

getValue

Private getWorkerId

  • Internal

    Returns the worker's ID.

    Remarks

    The value is masked by the maxValue to fit in the fragment's bits.

    Returns

    The worker's ID.

    Returns bigint

setBitShiftAndBitMask

  • Internal

    Parameters

    • bitsRightSide: number

    Returns void

updateId

Settings

Member Visibility

Theme

Generated using TypeDoc