discord.js | BitField

Search...

BitField

export class BitField<Flags extends string, Type extends number | bigint = number>

export class BitField<Flags extends string, Type extends number | bigint = number>

Data structure that makes it easy to interact with a bitfield.

Name	Constraints	Optional	Default	Description
Flags	string	No		None
Type	number \| bigint	Yes	number	None

constructor(bits?)

Name	Type	Optional	Description
bits	BitFieldResolvable<Flags, Type>	Yes	None

bitfield:Type

Bitfield of the packed bits

Static

Numeric bitfield flags. Defined in extension classes

[Symbol.iterator]():IterableIterator<Flags>

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

Adds bits to these ones.

These bits or new BitField if the instance is frozen.

Name	Type	Optional	Description
...bits	BitFieldResolvable<Flags, Type>[]	No	Bits to add

any(bit):boolean

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

Name	Type	Optional	Description
bit	BitFieldResolvable<Flags, Type>	No	Bit(s) to check for

equals(bit):boolean

Checks if this bitfield equals another

Name	Type	Optional	Description
bit	BitFieldResolvable<Flags, Type>	No	Bit(s) to check for

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

Freezes these bits, making them immutable.

has(bit):boolean

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

Name	Type	Optional	Description
bit	BitFieldResolvable<Flags, Type>	No	Bit(s) to check for

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

Gets all given bits that are missing from the bitfield.

Name	Type	Optional	Description
bits	BitFieldResolvable<Flags, Type>	No	Bit(s) to check for
...hasParams	readonly unknown[]	No	Additional parameters for the has method, if any

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

Removes bits from these.

These bits or new BitField if the instance is frozen.

Name	Type	Optional	Description
...bits	BitFieldResolvable<Flags, Type>[]	No	Bits to remove

Static

resolve(bit?):number | bigint

Resolves bitfields to their numeric form.

Name	Type	Optional	Description
bit	BitFieldResolvable<string, number \| bigint>	Yes	bit(s) to resolve

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

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

Name	Type	Optional	Description
...hasParams	readonly unknown[]	No	Additional parameters for the has method, if any

toArray(...hasParams):Flags[]

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

Name	Type	Optional	Description
...hasParams	readonly unknown[]	No	Additional parameters for the has method, if any

toJSON():Type extends number ? number : string

valueOf():Type