Class BitField<S, N>`Abstract`

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

Type Parameters

S extends string
N extends bigint | number

Hierarchy (view full)

BitField
- ModPermissionsBF

Index

Constructors

Properties

bitField constructor DefaultBit Flags

Methods

[iterator] add any equals freeze has missing remove serialize set toArray toJSON valueOf resolve

Constructors

constructor

new BitField<S, N>(...bits): BitField<S, N>
Type Parameters
- S extends string
- N extends number | bigint
Parameters
- Rest...bits: BitFieldResolvable<S, N>[]
Returns BitField<S, N>
- Defined in packages/util/src/BitField.ts:31

Properties

bitField

bitField: N

Bitfield of the packed bits

constructor

constructor: BitFieldConstructor<S, N>

`Static`DefaultBit

DefaultBit: number | bigint = 0

`Static`Flags

Flags: EnumLike<unknown, number | bigint> = {}

Numeric bitfield flags. Defined in extension classes

Methods

[iterator]

[iterator](): Generator<S, void, unknown>
Returns Generator<S, void, unknown>
- Defined in packages/util/src/BitField.ts:151

add

add(...bits): this
Adds bits to these ones.
Parameters
- Rest...bits: BitFieldResolvable<S, N>[]
  Bits to add
Returns this
These bits or new BitField if the instance is frozen.
- Defined in packages/util/src/BitField.ts:40

any

any(...bits): boolean
Checks whether the bitfield has a bit, or any of multiple bits.
Parameters
- Rest...bits: BitFieldResolvable<S, N>[]
  Bit(s) to check for
Returns boolean
- Defined in packages/util/src/BitField.ts:57

equals

equals(...bits): boolean
Checks if this bitfield equals another
Parameters
- Rest...bits: BitFieldResolvable<S, N>[]
  Bit(s) to check for
Returns boolean
- Defined in packages/util/src/BitField.ts:65

freeze

freeze(): Readonly<BitField<S, N>>
Freezes these bits, making them immutable.

Returns Readonly<BitField<S, N>>
- Defined in packages/util/src/BitField.ts:72

has

has(...bits): boolean
Checks whether the bitfield has a bit, or multiple bits.
Parameters
- Rest...bits: BitFieldResolvable<S, N>[]
  Bit(s) to check for
Returns boolean
- Defined in packages/util/src/BitField.ts:80

missing

missing(...bits): S[]
Gets all given bits that are missing from the bitfield.
Parameters
- Rest...bits: BitFieldResolvable<S, N>[]
  Bit(s) to check for
Returns S[]
- Defined in packages/util/src/BitField.ts:89

remove

remove(...bits): this
Removes bits from these.
Parameters
- Rest...bits: BitFieldResolvable<S, N>[]
  Bits to remove
Returns this
These bits or new BitField if the instance is frozen.
- Defined in packages/util/src/BitField.ts:98

serialize

serialize(): Record<S, boolean>
Gets an object mapping field names to a boolean indicating whether the bit is available.

Returns Record<S, boolean>
- Defined in packages/util/src/BitField.ts:115

set

set(...bits): this
Replace the bits with these.
Parameters
- Rest...bits: BitFieldResolvable<S, N>[]
  bits to set
Returns this
These bits or new BitField if the instance is frozen.
- Defined in packages/util/src/BitField.ts:126

toArray

toArray(): S[]
Gets an Array of bitfield names based on the bits available.

Returns S[]
- Defined in packages/util/src/BitField.ts:138

toJSON

toJSON(): string | N & number
Returns string | N & number
- Defined in packages/util/src/BitField.ts:143

valueOf

valueOf(): N
Returns N
- Defined in packages/util/src/BitField.ts:147

`Static`resolve

resolve<S, N>(bit): N
Resolves bitfields to their numeric form.
Type Parameters
- S extends string
- N extends number | bigint
Parameters
- bit: BitFieldResolvable<S, N>
  bit(s) to resolve
Returns N
- Defined in packages/util/src/BitField.ts:161