Class default

RandomFragment class for random IDs.

Hierarchy

  • default
    • default

Constructors

constructor

Properties

bitMask bitMaskHex bitShift bits identifier maxValue value

Methods

destructure getValue setBitShiftAndBitMask

Constructors

constructor

  • Remarks

    When using a custom random function, please ensure it returns a positive number no greater than 2 ** bits - 1.

    Throws

    [RND_FUNCTION_RETURN_TYPE] If custom function does not return number or bigint.

    Parameters

    • bits: number

      The number of bits for the fragment.

    • Optional fn: (() => number | bigint)

      Optional custom random function.

        • (): number | bigint

        • Returns number | bigint

    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

setBitShiftAndBitMask

  • Internal

    Parameters

    • bitsRightSide: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc