Options
All
  • Public
  • Public/Protected
  • All
Menu

bitfields

Index

Classes

Type aliases

Functions

Type aliases

BitfieldData

BitfieldData: Buffer | ArrayBuffer | TypedArray | number

Bitfield data.

BitfieldOptions

BitfieldOptions: { grow?: number }

Bitfield options.

property

{number} [grow] If you set an index that is out of bounds, the Bitfield will automatically grow to this value.

Type declaration

  • Optional grow?: number

    If you set an index that is out of bounds, the Bitfield will automatically grow to this value. If you want the Bitfield to infinitely grow, set this to Infinity.

TypedArray

TypedArray: Int8Array | Int16Array | Int32Array | Uint8Array | Uint16Array | Uint32Array

Represents any or all typed arrays in Node.

Functions

getByteSize

  • getByteSize(number: number): number

  • Get byte size of a number.

    Parameters

    • number: number

      Number

    Returns number

    Byte size

toBuffer

  • toBuffer(ab: ArrayBuffer): Buffer

  • Convert ArrayBuffer to Buffer.

    Parameters

    • ab: ArrayBuffer

      ArrayBuffer

    Returns Buffer

    Converted Buffer

Generated using TypeDoc