Preview environment

class UserFlagsBitField

export class UserFlagsBitField extends BitField<UserFlagsString>

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

bitfield : number

Bitfield of the packed bits

Inherited from: BitField

static
Flags : typeof UserFlags

Numeric user flags.

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

Inherited from: BitField

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

Adds bits to these ones.

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

Inherited from: BitField

any(
bit: BitFieldResolvable<UserFlagsString, number>
) : boolean

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

Inherited from: BitField

equals(
bit: BitFieldResolvable<UserFlagsString, number>
) : boolean

Checks if this bitfield equals another

Inherited from: BitField

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

Freezes these bits, making them immutable.

Inherited from: BitField

has(
bit: BitFieldResolvable<UserFlagsString, number>
) : boolean

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

Inherited from: BitField

missing(
bits: BitFieldResolvable<UserFlagsString, number>
...hasParams: readonly unknown[]
) : UserFlagsString[]

Gets all given bits that are missing from the bitfield.

Inherited from: BitField

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

Removes bits from these.

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

Inherited from: BitField

static
resolve(
bit?: BitFieldResolvable<UserFlagsString, number>
) : number

serialize(
...hasParams: readonly unknown[]
) : Record<UserFlagsString, boolean>

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

Inherited from: BitField

toArray(
...hasParams: readonly unknown[]
) : UserFlagsString[]

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

Inherited from: BitField

toJSON() : number extends number ? number : string

Inherited from: BitField

valueOf() : number

Inherited from: BitField