Class defaultAbstract

Base class for fragments.

Hierarchy

Constructors

constructor

Properties

bitMask bitMaskHex bitShift bits identifier maxValue value

Methods

destructure getValue setBitShiftAndBitMask

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

Abstract 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

Abstract getValue

  • Internal

    Returns the value for the fragment.

    Remarks

    Do not use this method outside of a Snowflakify instance.

    Returns bigint

setBitShiftAndBitMask

  • Internal

    Parameters

    • bitsRightSide: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc