Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BufferCodec

Hierarchy

  • BufferCodec

Index

Constructors

constructor

  • new BufferCodec(options?: BufferCodecConstructorOptions): BufferCodec
  • Creates a new instance of BufferCodec

    Parameters

    • options: BufferCodecConstructorOptions = ...

      Options for buffer codec

    Returns BufferCodec

Accessors

buffer

  • get buffer(): ArrayBuffer

offset

  • get offset(): number

Methods

decode

  • decode(options: BufferTypeOptions): any
  • Decode a single value from current offset

    Parameters

    • options: BufferTypeOptions

      Value decoding options

    Returns any

    Decoded value

float32

  • float32(value: number, littleEndian?: boolean): BufferCodec
  • Encode a 32-bit float

    Parameters

    • value: number

      32-bit numeric value

    • littleEndian: boolean = false

    Returns BufferCodec

    Current instance of BufferCodec

float64

  • float64(value: number, littleEndian?: boolean): BufferCodec
  • Encode a 64-bit float

    Parameters

    • value: number

      64-bit numeric value

    • littleEndian: boolean = false

    Returns BufferCodec

    Current instance of BufferCodec

int16

  • int16(value: number, littleEndian?: boolean): BufferCodec
  • Encode a signed 16-bit number

    Parameters

    • value: number

      16-bit numeric value

    • littleEndian: boolean = false

    Returns BufferCodec

    Current instance of BufferCodec

int32

  • int32(value: number, littleEndian?: boolean): BufferCodec
  • Encode a signed 32-bit number

    Parameters

    • value: number

      32-bit numeric value

    • littleEndian: boolean = false

    Returns BufferCodec

    Current instance of BufferCodec

int8

  • Encode a signed 8-bit number

    Parameters

    • value: number

      8-bit numeric value

    Returns BufferCodec

    Current instance of BufferCodec

parse

result

  • result(): ArrayBuffer
  • Encode all queued values and return resulting buffer

    Returns ArrayBuffer

    Encoded buffer

setEncoding

  • setEncoding(encoding: BufferStringEncoding): BufferCodec
  • Sets string encoding

    Parameters

    • encoding: BufferStringEncoding

      String encoding (either 'utf8' or 'utf16')

    Returns BufferCodec

    Current instance of BufferCodec

string

  • string(value: string, encoding?: BufferStringEncoding): BufferCodec
  • Encodes a string value

    Parameters

    • value: string

      String to encode

    • encoding: BufferStringEncoding = ...

      String encoding (either 'utf8' or 'utf16'). This parameter takes precedence over the general encoding property set on BufferCodec instance

    Returns BufferCodec

    Current instance of BufferCodec

uint16

  • uint16(value: number, littleEndian?: boolean): BufferCodec
  • Encode an unsigned 16-bit number

    Parameters

    • value: number

      16-bit numeric value

    • littleEndian: boolean = false

    Returns BufferCodec

    Current instance of BufferCodec

uint32

  • uint32(value: number, littleEndian?: boolean): BufferCodec
  • Encode an unsigned 32-bit number

    Parameters

    • value: number

      32-bit numeric value

    • littleEndian: boolean = false

    Returns BufferCodec

    Current instance of BufferCodec

uint8

  • Encode an unsigned 8-bit number

    Parameters

    • value: number

      8-bit numeric value

    Returns BufferCodec

    Current instance of BufferCodec

Static from

  • Creates a new BufferCodec instance from given buffer

    Parameters

    • buffer: Buffer | ArrayBuffer

      Either ArrayBuffer or Buffer

    Returns BufferCodec

    A new instance of BufferCodec

Generated using TypeDoc