Class BitField<S, N>Abstract

constructor

• new BitField<S, N>(...bits): BitField<S, N>

• Type Parameters

  • S extends string
  • N extends number | bigint

  Parameters

  • Rest...bits: BitFieldResolvable<S, N>[]

  Returns BitField<S, N>

bitField

constructor

StaticDefaultBit

StaticFlags

[iterator]

• [iterator](): Generator<S, void, unknown>

• Returns Generator<S, void, unknown>

add

• add(...bits): this

• Adds bits to these ones.

  Parameters

  • Rest...bits: BitFieldResolvable<S, N>[]

    Bits to add

  Returns this

  These bits or new BitField if the instance is frozen.

any

• any(...bits): boolean

• Checks whether the bitfield has a bit, or any of multiple bits.

  Parameters

  • Rest...bits: BitFieldResolvable<S, N>[]

    Bit(s) to check for

  Returns boolean

equals

• equals(...bits): boolean

• Checks if this bitfield equals another

  Parameters

  • Rest...bits: BitFieldResolvable<S, N>[]

    Bit(s) to check for

  Returns boolean

freeze

• freeze(): Readonly<BitField<S, N>>

• Freezes these bits, making them immutable.

  Returns Readonly<BitField<S, N>>

has

• has(...bits): boolean

• Checks whether the bitfield has a bit, or multiple bits.

  Parameters

  • Rest...bits: BitFieldResolvable<S, N>[]

    Bit(s) to check for

  Returns boolean

missing

• missing(...bits): S[]

• Gets all given bits that are missing from the bitfield.

  Parameters

  • Rest...bits: BitFieldResolvable<S, N>[]

    Bit(s) to check for

  Returns S[]

remove

• remove(...bits): this

• Removes bits from these.

  Parameters

  • Rest...bits: BitFieldResolvable<S, N>[]

    Bits to remove

  Returns this

  These bits or new BitField if the instance is frozen.

serialize

• serialize(): Record<S, boolean>

• Gets an object mapping field names to a boolean indicating whether the bit is available.

  Returns Record<S, boolean>

set

• set(...bits): this

• Replace the bits with these.

  Parameters

  • Rest...bits: BitFieldResolvable<S, N>[]

    bits to set

  Returns this

  These bits or new BitField if the instance is frozen.

toArray

• toArray(): S[]

• Gets an Array of bitfield names based on the bits available.

  Returns S[]

toJSON

• toJSON(): string | N & number

• Returns string | N & number

valueOf

• valueOf(): N

• Returns N

Staticresolve

• resolve<S, N>(bit): N

• Resolves bitfields to their numeric form.

  Type Parameters

  • S extends string
  • N extends number | bigint

  Parameters

  • bit: BitFieldResolvable<S, N>

    bit(s) to resolve

  Returns N