Class BitField<S, N>Abstract

constructor

• new BitField<S extends string, N extends number | bigint>(
      ...bits: BitFieldResolvable<S, N>[],
  ): BitField<S, N>

  Type Parameters

  • S extends string
  • N extends number | bigint

  Parameters

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

  Returns BitField<S, N>

bitField

constructor

Static ReadonlyDefaultBit

Static ReadonlyFlags

[iterator]

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

  Returns Generator<S, void, unknown>

add

• add(...bits: BitFieldResolvable<S, N>[]): this

  Adds bits to these ones.

  Parameters

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

    Bits to add

  Returns this

  These bits or new BitField if the instance is frozen.

any

• any(...bits: BitFieldResolvable<S, N>[]): boolean

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

  Parameters

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

    Bit(s) to check for

  Returns boolean

equals

• equals(...bits: BitFieldResolvable<S, N>[]): boolean

  Checks if this bitfield equals another

  Parameters

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

    Bit(s) to check for

  Returns boolean

freeze

• freeze(): Readonly<this>

  Freezes these bits, making them immutable.

  Returns Readonly<this>

has

• has(...bits: BitFieldResolvable<S, N>[]): boolean

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

  Parameters

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

    Bit(s) to check for

  Returns boolean

missing

• missing(...bits: BitFieldResolvable<S, N>[]): S[]

  Gets all given bits that are missing from the bitfield.

  Parameters

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

    Bit(s) to check for

  Returns S[]

remove

• remove(...bits: BitFieldResolvable<S, N>[]): this

  Removes bits from these.

  Parameters

  • ...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: BitFieldResolvable<S, N>[]): this

  Replace the bits with these.

  Parameters

  • ...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(): N extends number ? N<N> : `${N}`

  Returns N extends number ? N<N> : `${N}`

toString

• toString(): `${N}`

  Returns `${N}`

valueOf

• valueOf(): N

  Returns N

Staticresolve

• resolve<S extends string, N extends number | bigint>(
      bit: BitFieldResolvable<S, N>,
  ): 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