discord.js | BitField

Search...

BitField

export class BitField<S extends string, N extends number | bigint = number>

export class BitField<S extends string, N extends number | bigint = number>

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

Name	Constraints	Optional	Default	Description
S	string	No		None
N	number \| bigint	Yes	number	None

constructor(bits?)

Name	Type	Optional	Description
bits	BitFieldResolvable<S, N>	Yes	None

bitfield:N

Bitfield of the packed bits

Static

Flags:EnumLike<unknown, number | bigint>

Numeric bitfield flags. Defined in extension classes

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

add(...bits):BitField<S, N>

Adds bits to these ones.

These bits or new BitField if the instance is frozen.

Name	Type	Optional	Description
...bits	BitFieldResolvable<S, N>[]	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<S, N>	No	Bit(s) to check for

equals(bit):boolean

Checks if this bitfield equals another

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

freeze():Readonly<BitField<S, N>>

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<S, N>	No	Bit(s) to check for

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

Gets all given bits that are missing from the bitfield.

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

remove(...bits):BitField<S, N>

Removes bits from these.

These bits or new BitField if the instance is frozen.

Name	Type	Optional	Description
...bits	BitFieldResolvable<S, N>[]	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<S, boolean>

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

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

toArray(...hasParams):S[]

Gets an 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():N extends number ? number : string

valueOf():N