BitField

classe · Source

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

Constructor

new BitField(bits?: BitFieldResolvable)

Parameters

Name	Type	Description
bits?	BitFieldResolvable	Bit(s) to read from Default: this.constructor.defaultBit.

Properties

bitfield

bitfield: number | bigint

Bitfield of the packed bits Source

FLAGS

static · abstract

FLAGS: Object

Numeric bitfield flags. Defined in extension classes Source

defaultBit

static · private

defaultBit: number | bigint

[Source](https://github.com/AltKit/discord/blob/selfbotjs/src/util/BitField.js#L168)

Methods

any

any(bit: BitFieldResolvable): boolean

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

Name	Type	Description
bit	BitFieldResolvable	Bit(s) to check for

Returns: booleanSource

equals

equals(bit: BitFieldResolvable): boolean

Checks if this bitfield equals another Parameters

Name	Type	Description
bit	BitFieldResolvable	Bit(s) to check for

Returns: booleanSource

has

has(bit: BitFieldResolvable): boolean

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

Name	Type	Description
bit	BitFieldResolvable	Bit(s) to check for

Returns: booleanSource

missing

missing(bits: BitFieldResolvable, hasParams: *): Array<string>

Gets all given bits that are missing from the bitfield. Parameters

Name	Type	Description
bits	BitFieldResolvable	Bit(s) to check for
hasParams	*	Additional parameters for the has method, if any

Returns: Array<string>Source

freeze

freeze(): Readonly<BitField>

Freezes these bits, making them immutable. Returns: Readonly<BitField>Source

add

add(bits?: BitFieldResolvable): BitField

Adds bits to these ones. Parameters

Name	Type	Description
bits?	BitFieldResolvable	Bits to add

Returns: BitField — These bits or new BitField if the instance is frozen. Source

remove

remove(bits?: BitFieldResolvable): BitField

Removes bits from these. Parameters

Name	Type	Description
bits?	BitFieldResolvable	Bits to remove

Returns: BitField — These bits or new BitField if the instance is frozen. Source

serialize

serialize(hasParams: *): Object

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

Name	Type	Description
hasParams	*	Additional parameters for the has method, if any

Returns: ObjectSource

toArray

toArray(hasParams: *): Array<string>

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

Name	Type	Description
hasParams	*	Additional parameters for the has method, if any

Returns: Array<string>Source

resolve

static

resolve(bit?: BitFieldResolvable): numberbigint

Resolves bitfields to their numeric form. Parameters

Name	Type	Description
bit?	BitFieldResolvable	bit(s) to resolve

Returns: numberbigintSource