Class default

NetworkFragment class for network IDs.

Hierarchy

  • default
    • default

Constructors

constructor

Properties

bitMask bitMaskHex bitShift bits identifier maxValue networkAddress value

Methods

destructure getNetworkId getValue setBitShiftAndBitMask updateId

Constructors

constructor

  • Throws

    [NETWORK_ADDRESS_INVALID] If networkAddress is not "ipv4" or "mac".

    Parameters

    • bits: number

      The number of bits for the fragment.

    • networkAddress: "ipv4" | "mac" = 'ipv4'

      The type of network address to use, "ipv4" or "mac".

      Defaults to "ipv4" 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

Readonly networkAddress

networkAddress: "ipv4" | "mac" = 'ipv4'

value

value: bigint

The current value of the fragment.

Methods

destructure

Private getNetworkId

  • Internal

    Returns the network ID.

    Remarks

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

    Returns

    The network ID of the machine based on a non internal network address.

    Returns bigint

getValue

setBitShiftAndBitMask

  • Internal

    Parameters

    • bitsRightSide: number

    Returns void

updateId

Settings

Member Visibility

Theme

Generated using TypeDoc