Class: BitField<Flags>
bitfield/src.BitField
Type parameters
Name | Type |
---|---|
Flags | extends Record <string , number > | Record <string , bigint > |
Constructors
constructor
• new BitField<Flags
>(flags
)
Type parameters
Name | Type |
---|---|
Flags | extends Record <string , number > | Record <string , bigint > |
Parameters
Name | Type |
---|---|
flags | Readonly <Flags > |
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:7
Properties
flags
• Readonly
flags: Flags
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:5
mask
• Readonly
mask: PrimitiveType
<Flags
[keyof Flags
]>
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:4
type
• Readonly
type: Flags
[keyof Flags
] extends number
? "number"
: "bigint"
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:2
zero
• Readonly
zero: Flags
[keyof Flags
] extends number
? 0
: 0n
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:3
Methods
any
▸ any(field
, bits
): boolean
Parameters
Name | Type | Description |
---|---|---|
field | MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>> | |
bits | MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>> |
Returns
boolean
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:81
complement
▸ complement(field
): PrimitiveType
<Flags
[keyof Flags
]>
Parameters
Name | Type | Description |
---|---|---|
field | MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>> |
Returns
PrimitiveType
<Flags
[keyof Flags
]>
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:114
difference
▸ difference(a
, b
): PrimitiveType
<Flags
[keyof Flags
]>
Parameters
Name | Type | Description |
---|---|---|
a | MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>> | |
b | MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>> |
Returns
PrimitiveType
<Flags
[keyof Flags
]>
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:183
has
▸ has(field
, bits
): boolean
Parameters
Name | Type | Description |
---|---|---|
field | MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>> | |
bits | MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>> |
Returns
boolean
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:91
intersection
▸ intersection(bitfield
, ...fields
): PrimitiveType
<Flags
[keyof Flags
]>
Parameters
Name | Type | Description |
---|---|---|
bitfield | MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>> | |
...fields | readonly MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>>[] |
Returns
PrimitiveType
<Flags
[keyof Flags
]>
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:159
resolve
▸ resolve(resolvable
): PrimitiveType
<Flags
[keyof Flags
]>
Parameters
Name | Type | Description |
---|---|---|
resolvable | MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>> |
Returns
PrimitiveType
<Flags
[keyof Flags
]>
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:60
symmetricDifference
▸ symmetricDifference(a
, b
): PrimitiveType
<Flags
[keyof Flags
]>
Parameters
Name | Type | Description |
---|---|---|
a | MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>> | |
b | MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>> |
Returns
PrimitiveType
<Flags
[keyof Flags
]>
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:205
toArray
▸ toArray(field
): keyof Flags
[]
Parameters
Name | Type | Description |
---|---|---|
field | MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>> |
Returns
keyof Flags
[]
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:226
toObject
▸ toObject(field
): Record
<keyof Flags
, boolean
>
Parameters
Name | Type | Description |
---|---|---|
field | MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>> |
Returns
Record
<keyof Flags
, boolean
>
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:260
union
▸ union(...fields
): PrimitiveType
<Flags
[keyof Flags
]>
Parameters
Name | Type | Description |
---|---|---|
...fields | readonly MaybeArray <keyof Flags | PrimitiveType <Flags [keyof Flags ]>>[] |
Returns
PrimitiveType
<Flags
[keyof Flags
]>
Defined in
projects/utilities/packages/bitfield/src/lib/BitField.ts:132