Appearance
BitField
Package: @erinjs/util
Constructor
| Name | Type | Optional | Description |
|---|---|---|---|
bits | BitFieldResolvable<S> | No |
Properties
| Name | Type | Readonly | Optional | Description |
|---|---|---|---|---|
[Symbol.toStringTag] | string | Yes | No | |
bitfield | bigint | No | No | |
defaultBit | number | No | No | |
Flags | Record<string, bigint> | No | No |
Methods
add()
Returns: this
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
bits | BitFieldResolvable<S>[] | No |
equals()
Returns: boolean
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
bitfield | BitField<S> | No |
freeze()
Returns: Readonly<BitField<S>>
Parameters:
None
has()
Returns: boolean
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
bit | BitFieldResolvable<S> | No |
remove()
Returns: this
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
bits | BitFieldResolvable<S>[] | No |
resolve()
Returns: bigint
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
bits | BitFieldResolvable<S> | No |
serialize()
Returns: Record<S, boolean>
Parameters:
None
toArray()
Returns: S[]
Parameters:
None
toJSON()
Returns: string
Parameters:
None
valueOf()
Returns: string
Parameters:
None