Class SystemChannelFlagsBitField

Utility class for working with user flags

Hierarchy

SystemChannelFlagsBitField

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SystemChannelFlagsBitField(bits: SystemChannelFlagsCheckType): SystemChannelFlagsBitField

- Defined in src/utils/bitfield/SystemChannelFlagsBitField.ts:14
Parameters
- bits: SystemChannelFlagsCheckType
Returns SystemChannelFlagsBitField

Properties

bitfield

bitfield: number

Static Flags

Flags: typeof GuildSystemChannelFlags = GuildSystemChannelFlags

Object containing all available user flags

Static defaultBit

defaultBit: number = 0

The default bit

Methods

add

add(...bits: SystemChannelFlagsCheckType[]): SystemChannelFlagsBitField

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

Parameters
- Rest ...bits: SystemChannelFlagsCheckType[]
Returns SystemChannelFlagsBitField

has

has(bit: SystemChannelFlagsCheckType): boolean

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

Parameters
- bit: SystemChannelFlagsCheckType
Returns boolean

remove

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

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

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

toArray

toArray(): string[]

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

Returns string[]

Static parse

parse(bit: SystemChannelFlagsCheckType): number

- Defined in src/utils/bitfield/SystemChannelFlagsBitField.ts:48
Parameters
- bit: SystemChannelFlagsCheckType
Returns number

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