Class Bitfield

Represents a Bitfield.

Hierarchy

Bitfield

Index

Constructors

constructor

Properties

array
grow

Methods

Constructors

constructor

new Bitfield(data?: BitfieldData, opts?: BitfieldOptions): Bitfield

- Defined in Bitfield.ts:88
Create a Bitfield.

Parameters
- data: BitfieldData = 0
  
  Can be a Node.js Buffer, ArrayBuffer, typed array, numeric array, or a number representing the amount of bytes in the Bitfield
- Optional opts: BitfieldOptions
  
  Other options
Returns Bitfield

Properties

array

array: TypedArray

Underlying typed array. Changing this manually may break the Bitfield or cause unexpected bugs.

grow

grow: number

Value of the grow option.

Methods

clear

clear(): void

- Defined in Bitfield.ts:158
Reset all bits.

Returns void

get

get(index: number): boolean

- Defined in Bitfield.ts:116
Check if a bit is set.

Parameters
- index: number
  
  Bit index
Returns boolean

True if the bit is set

set

set(index: number, value?: number | boolean): void

- Defined in Bitfield.ts:131
Set a bit.

Parameters
- index: number
  
  Bit index
- value: number | boolean = true
  
  Bit value
Returns void

toBigInt

toBigInt(): BigInt

- Defined in Bitfield.ts:181
Convert Bitfield into a BigInt.

Returns BigInt

Node.js BigInt

toBuffer

toBuffer(): Buffer

- Defined in Bitfield.ts:170
Convert Bitfield into a Buffer.

Returns Buffer

Node.js Buffer

toHex

toHex(): string

- Defined in Bitfield.ts:192
Convert Bitfield into a hexadecimal string.

Returns string

Hexadecimal string

toString

toString(): string

- Defined in Bitfield.ts:203
Convert Bitfield into a UTF-8 encoded string.

Returns string

UTF-8 encoded string

Static fromBigInt

fromBigInt(bigint: bigint, opts?: BitfieldOptions): Bitfield

- Defined in Bitfield.ts:236
Create a Bitfield from a BigInt.

static

Parameters
- bigint: bigint
  
  BigInt
- Optional opts: BitfieldOptions
  
  Bitfield options
Returns Bitfield

Bitfield

Static fromBuffer

fromBuffer(buffer: ArrayBuffer | Buffer, opts?: BitfieldOptions): Bitfield

- Defined in Bitfield.ts:218
Create a Bitfield from a Buffer or ArrayBuffer.

static

Parameters
- buffer: ArrayBuffer | Buffer
  
  Buffer
- Optional opts: BitfieldOptions
  
  Bitfield options
Returns Bitfield

Bitfield

Static fromHex

fromHex(hex: string, opts?: BitfieldOptions): Bitfield

- Defined in Bitfield.ts:251
Create a Bitfield from a hexadecimal string.

static

Parameters
- hex: string
  
  Hexadecimal string
- Optional opts: BitfieldOptions
  
  Bitfield options
Returns Bitfield

Bitfield

Static fromString

fromString(string: string, opts?: BitfieldOptions): Bitfield

- Defined in Bitfield.ts:266
Create a Bitfield from a UTF-8 encoded string.

static

Parameters
- string: string
  
  UTF-8 encoded string.
- Optional opts: BitfieldOptions
  
  Bitfield options
Returns Bitfield

Bitfield

Generated using TypeDoc