Class BitField<Flags, Type>

constructor

• new BitField<Flags extends string, Type extends number | bigint = number>(
      bits?: BitFieldResolvable<Flags, Type>,
  ): BitField<Flags, Type>

  Type Parameters

  • Flags extends string
  • Type extends number | bigint = number

  Parameters

  • Optionalbits: BitFieldResolvable<Flags, Type>

  Returns BitField<Flags, Type>

bitfield

StaticFlags

[iterator]

• "[iterator]"(): IterableIterator<Flags>

  Returns IterableIterator<Flags>

add

• add(...bits: BitFieldResolvable<Flags, Type>[]): BitField<Flags, Type>

  Parameters

  • ...bits: BitFieldResolvable<Flags, Type>[]

  Returns BitField<Flags, Type>

any

• any(bit: BitFieldResolvable<Flags, Type>): boolean

  Parameters

  • bit: BitFieldResolvable<Flags, Type>

  Returns boolean

equals

• equals(bit: BitFieldResolvable<Flags, Type>): boolean

  Parameters

  • bit: BitFieldResolvable<Flags, Type>

  Returns boolean

freeze

• freeze(): Readonly<BitField<Flags, Type>>

  Returns Readonly<BitField<Flags, Type>>

has

• has(bit: BitFieldResolvable<Flags, Type>): boolean

  Parameters

  • bit: BitFieldResolvable<Flags, Type>

  Returns boolean

missing

• missing(
      bits: BitFieldResolvable<Flags, Type>,
      ...hasParams: readonly unknown[],
  ): Flags[]

  Parameters

  • bits: BitFieldResolvable<Flags, Type>
  • ...hasParams: readonly unknown[]

  Returns Flags[]

remove

• remove(...bits: BitFieldResolvable<Flags, Type>[]): BitField<Flags, Type>

  Parameters

  • ...bits: BitFieldResolvable<Flags, Type>[]

  Returns BitField<Flags, Type>

serialize

• serialize(...hasParams: readonly unknown[]): Record<Flags, boolean>

  Parameters

  • ...hasParams: readonly unknown[]

  Returns Record<Flags, boolean>

toArray

• toArray(...hasParams: readonly unknown[]): Flags[]

  Parameters

  • ...hasParams: readonly unknown[]

  Returns Flags[]

toJSON

• toJSON(): Type extends number ? number : string

  Returns Type extends number ? number : string

valueOf

• valueOf(): Type

  Returns Type

Staticresolve

• resolve(bit?: BitFieldResolvable<string, number | bigint>): number | bigint

  Parameters

  • Optionalbit: BitFieldResolvable<string, number | bigint>

  Returns number | bigint