Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BufferReader

Hierarchy

  • BufferReader

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new BufferReader(options?: Buffer | SmartBufferOptions): BufferReader

  • Parameters

    • Optional options: Buffer | SmartBufferOptions

    Returns BufferReader

Properties

smartBuffer

smartBuffer: SmartBuffer

Accessors

internalBuffer

  • get internalBuffer(): Buffer

  • Returns Buffer

readOffset

  • get readOffset(): number
  • set readOffset(val: number): void

  • Returns number

  • Parameters

    • val: number

    Returns void

Methods

readBigUInt64BE

  • readBigUInt64BE(): bigint

  • Returns bigint

readBigUIntBE

  • readBigUIntBE(length: number): bigint

  • Parameters

    • length: number

    Returns bigint

readBigUIntLE

  • readBigUIntLE(length: number): bigint

  • Parameters

    • length: number

    Returns bigint

readBuffer

  • readBuffer(length: number): Buffer

  • Parameters

    • length: number

    Returns Buffer

readString

  • readString(arg?: number | BufferEncoding, encoding?: BufferEncoding): string

  • Parameters

    • Optional arg: number | BufferEncoding
    • Optional encoding: BufferEncoding

    Returns string

readUInt16BE

  • readUInt16BE(): number

  • Returns number

readUInt32BE

  • readUInt32BE(offset?: number): number

  • Parameters

    • Optional offset: number

    Returns number

readUInt8

  • readUInt8(): number

  • Returns number

readUInt8Enum

  • readUInt8Enum<T, TEnumValue>(enumVariable: {[ key in string]: TEnumValue }, invalidEnumErrorFormatter: (val: number) => Error): TEnumValue

  • Type parameters

    • T: string

    • TEnumValue: number

    Parameters

    • enumVariable: {[ key in string]: TEnumValue }
    • invalidEnumErrorFormatter: (val: number) => Error
        • (val: number): Error

        • Parameters

          • val: number

          Returns Error

    Returns TEnumValue

Static fromBuffer

  • Parameters

    • buffer: Buffer

    Returns BufferReader

Generated using TypeDoc