Class MessageFlagsBitField

Utility class for working with message flags

Hierarchy

MessageFlagsBitField

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MessageFlagsBitField(bits: MessageFlagsCheckType): MessageFlagsBitField

- Defined in src/utils/bitfield/MessageFlagsBitField.ts:14
Parameters
- bits: MessageFlagsCheckType
Returns MessageFlagsBitField

Properties

bitfield

bitfield: number

Static Flags

Flags: typeof MessageFlags = MessageFlags

Object containing all available message flags

Static defaultBit

defaultBit: number = 0

The default bit

Methods

add

add(...bits: MessageFlagsCheckType[]): MessageFlagsBitField

- Defined in src/utils/bitfield/MessageFlagsBitField.ts:19
Adds bits to these ones

Parameters
- Rest ...bits: MessageFlagsCheckType[]
Returns MessageFlagsBitField

has

has(bit: MessageFlagsCheckType): boolean

- Defined in src/utils/bitfield/MessageFlagsBitField.ts:27
Checks whether the bitfield has a bit, or multiple bits

Parameters
- bit: MessageFlagsCheckType
Returns boolean

remove

remove(...bits: any[]): MessageFlagsBitField

- Defined in src/utils/bitfield/MessageFlagsBitField.ts:34
Removes bits from these

Parameters
- Rest ...bits: any[]
Returns MessageFlagsBitField

toArray

toArray(): string[]

- Defined in src/utils/bitfield/MessageFlagsBitField.ts:44
Gets an Array of MessageFlags names based on the bits available

Returns string[]

Static parse

parse(bit: MessageFlagsCheckType): number

- Defined in src/utils/bitfield/MessageFlagsBitField.ts:48
Parameters
- bit: MessageFlagsCheckType
Returns number

Generated using TypeDoc version 0.22.16, the 9/16/2022 at 1:09:15 AM