Class BitField<Flags, Type>

constructor

• new BitField<Flags, Type>(bits?): BitField<Flags, Type>

• Type Parameters

  • Flags extends string

  • Type extends number | bigint = number

  Parameters

  • Optional bits: BitFieldResolvable<Flags, Type>

  Returns BitField<Flags, Type>

bitfield

Static Flags

[iterator]

• [iterator](): IterableIterator<Flags>

• Returns IterableIterator<Flags>

add

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

• Parameters

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

  Returns BitField<Flags, Type>

any

• any(bit): boolean

• Parameters

  • bit: BitFieldResolvable<Flags, Type>

  Returns boolean

equals

• equals(bit): boolean

• Parameters

  • bit: BitFieldResolvable<Flags, Type>

  Returns boolean

freeze

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

• Returns Readonly<BitField<Flags, Type>>

has

• has(bit): boolean

• Parameters

  • bit: BitFieldResolvable<Flags, Type>

  Returns boolean

missing

• missing(bits, ...hasParams): Flags[]

• Parameters

  • bits: BitFieldResolvable<Flags, Type>

  • Rest ...hasParams: readonly unknown[]

  Returns Flags[]

remove

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

• Parameters

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

  Returns BitField<Flags, Type>

serialize

• serialize(...hasParams): Record<Flags, boolean>

• Parameters

  • Rest ...hasParams: readonly unknown[]

  Returns Record<Flags, boolean>

toArray

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

• Parameters

  • Rest ...hasParams: readonly unknown[]

  Returns Flags[]

toJSON

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

• Returns Type extends number
      ? number
      : string

valueOf

• valueOf(): Type

• Returns Type

Static resolve

• resolve(bit?): number | bigint

• Parameters

  • Optional bit: BitFieldResolvable<string, number | bigint>

  Returns number | bigint