discord.js | UserFlagsBitField

Search...

UserFlagsBitField

export class UserFlagsBitField extends BitField<UserFlagsString>

export class UserFlagsBitField extends BitField<UserFlagsString>

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

Extends

BitField<UserFlagsString>

bitfield:number

Bitfield of the packed bits

Inherited from BitField

Static

Flags:typeof UserFlags

Numeric user flags.

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

add(...bits):BitField<UserFlagsString, number>

Adds bits to these ones.

Returns

These bits or new BitField if the instance is frozen.

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

Inherited from BitField

any(bit):boolean

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

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

Inherited from BitField

equals(bit):boolean

Checks if this bitfield equals another

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

Inherited from BitField

freeze():Readonly<BitField<UserFlagsString, number>>

Freezes these bits, making them immutable.

Inherited from BitField

has(bit):boolean

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

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

Inherited from BitField

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

Gets all given bits that are missing from the bitfield.

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

Inherited from BitField

remove(...bits):BitField<UserFlagsString, number>

Removes bits from these.

Returns

These bits or new BitField if the instance is frozen.

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

Inherited from BitField

Static

resolve(bit?):number

Name	Type	Optional	Description
bit	BitFieldResolvable<UserFlagsString, number>	Yes	None

serialize(...hasParams):Record<UserFlagsString, 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

Inherited from BitField

toArray(...hasParams):UserFlagsString[]

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

Inherited from BitField

toJSON():number extends number ? number : string

valueOf():number