Class BitField<TEnum, TValue>

constructor

• new BitField<
      TEnum extends Record<string, number | bigint> = Record<string, number>,
      TValue = TEnum[keyof TEnum],
  >(
      bits?: BitFieldResolvable<TValue>,
  ): BitField<TEnum, TValue>

  Bit(s) to read from

  Type Parameters

  • TEnum extends Record<string, number | bigint> = Record<string, number>
  • TValue = TEnum[keyof TEnum]

  Parameters

  • bits: BitFieldResolvable<TValue> = ...

  Returns BitField<TEnum, TValue>

bitfield

StaticDefaultBit

StaticFlags

[iterator]

• "[iterator]"(...hasParams: any[]): IterableIterator<string>

  Parameters

  • ...hasParams: any[]

  Returns IterableIterator<string>

add

• add(...bits: any[]): BitField<Record<string, number>, any>

  Adds bits to these ones.

  Parameters

  • ...bits: any[]

  Returns BitField<Record<string, number>, any>

any

• any(bit: BitFieldResolvable): boolean

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

  Parameters

  • bit: BitFieldResolvable

    Bit(s) to check for

  Returns boolean

equals

• equals(bit: BitFieldResolvable): boolean

  Checks if this bitfield equals another

  Parameters

  • bit: BitFieldResolvable

    Bit(s) to check for

  Returns boolean

freeze

• freeze(): Readonly<this>

  Freezes these bits, making them immutable.

  Returns Readonly<this>

has

• has(bit: BitFieldResolvable): boolean

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

  Parameters

  • bit: BitFieldResolvable

    Bit(s) to check for

  Returns boolean

missing

• missing(bits: BitFieldResolvable, ...hasParams: any[]): string[]

  Gets all given bits that are missing from the bitfield.

  Parameters

  • bits: BitFieldResolvable

    Bit(s) to check for

  • ...hasParams: any[]

    Additional parameters for the has method, if any

  Returns string[]

remove

• remove(...bits: BitFieldResolvable<number>[]): this

  Removes bits from these.

  Parameters

  • ...bits: BitFieldResolvable<number>[]

  Returns this

serialize

• serialize(...hasParams: any[]): Record<string, boolean>

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

  Parameters

  • ...hasParams: any[]

    Additional parameters for the has method, if any

  Returns Record<string, boolean>

toArray

• toArray(...hasParams: any[]): string[]

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

  Parameters

  • ...hasParams: any[]

  Returns string[]

toJSON

• toJSON(): string | number

  Returns string | number

valueOf

• valueOf(): number | bigint

  Returns number | bigint

Staticresolve

• resolve(this: typeof BitField, bit?: BitFieldResolvable): number | bigint

  Data that can be resolved to give a bitfield. This can be:

  • A bit number (this can be a number literal or a value taken from BitField.Flags)
  • A string bit number
  • An instance of BitField
  • An Array of BitFieldResolvable

  Parameters

  • this: typeof BitField
  • bit: BitFieldResolvable = ...

  Returns number | bigint