Class readableBufferBase<IsAsync>Abstract

constructor

• new readableBufferBase<IsAsync extends boolean = boolean>(): readableBufferBase<
      IsAsync,
  >

  Type Parameters

  • IsAsync extends boolean = boolean

  Returns readableBufferBase<IsAsync>

read

readArrayBackwardsEndian

readArrayEndian

readBackwards

readBackwardsEndian

readEndian

readUint8ArrayBackwardsEndian

readUint8ArrayEndian

isLe

• get isLe(): boolean

  If the buffer is little endian

  Returns boolean
• set isLe(isLe: boolean): void

  If the buffer is little endian

  Parameters

  • isLe: boolean

  Returns void

AbstractreadArray

• readArray(bytes: number): MaybePromise<number[], IsAsync>

  Read a number array (0-255) from the start of the buffer

  Parameters

  • bytes: number

    How many bytes to read

  Returns MaybePromise<number[], IsAsync>

AbstractreadArrayBackwards

• readArrayBackwards(bytes: number): MaybePromise<number[], IsAsync>

  Read a number array (0-255) from the start of the buffer backwards

  Parameters

  • bytes: number

    How many bytes to read

  Returns MaybePromise<number[], IsAsync>

readDouble

• readDouble(): | (
      MaybePromise<number[], IsAsync> extends Promise<unknown>
          ? Promise<number>
          : number
  )
  | (
      MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
          unknown,
      >
          ? Promise<number>
          : number
  )

  Parse a double

  Returns
      | (
          MaybePromise<number[], IsAsync> extends Promise<unknown>
              ? Promise<number>
              : number
      )
      | (
          MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
              unknown,
          >
              ? Promise<number>
              : number
      )

  The parsed float

readFloat

• readFloat(): | (
      MaybePromise<number[], IsAsync> extends Promise<unknown>
          ? Promise<number>
          : number
  )
  | (
      MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
          unknown,
      >
          ? Promise<number>
          : number
  )

  Parse a float

  Returns
      | (
          MaybePromise<number[], IsAsync> extends Promise<unknown>
              ? Promise<number>
              : number
      )
      | (
          MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
              unknown,
          >
              ? Promise<number>
              : number
      )

  The parsed float

readReadableBuffer

• readReadableBuffer(
      bytes: number,
  ): MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
      unknown,
  >
      ? Promise<readableBuffer>
      : readableBuffer

  Read a ReadableBuffer from the start of the buffer

  Parameters

  • bytes: number

    How many bytes to read

  Returns MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<unknown>
      ? Promise<readableBuffer>
      : readableBuffer

readSignedInteger

• readSignedInteger(
      bytes: number,
  ):
      | (
          (
              MaybePromise<number[], IsAsync> extends Promise<unknown>
                  ? Promise<number>
                  : number
          ) extends Promise<unknown>
              ? Promise<number>
              : number
      )
      | (
          (
              MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
                  unknown,
              >
                  ? Promise<number>
                  : number
          ) extends Promise<unknown>
              ? Promise<number>
              : number
      )

  Parse a signed integer

  Parameters

  • bytes: number

    How many bytes long the signed integer is

  Returns
      | (
          (
              MaybePromise<number[], IsAsync> extends Promise<unknown>
                  ? Promise<number>
                  : number
          ) extends Promise<unknown>
              ? Promise<number>
              : number
      )
      | (
          (
              MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
                  unknown,
              >
                  ? Promise<number>
                  : number
          ) extends Promise<unknown>
              ? Promise<number>
              : number
      )

  The parsed signed integer

readSignedIntegerBigint

• readSignedIntegerBigint(
      bytes: number,
  ):
      | (
          (
              MaybePromise<number[], IsAsync> extends Promise<unknown>
                  ? Promise<bigint>
                  : bigint
          ) extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )
      | (
          (
              MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
                  unknown,
              >
                  ? Promise<bigint>
                  : bigint
          ) extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )

  Parse a signed integer as a bigint

  Parameters

  • bytes: number

    How many bytes long the signed integer is

  Returns
      | (
          (
              MaybePromise<number[], IsAsync> extends Promise<unknown>
                  ? Promise<bigint>
                  : bigint
          ) extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )
      | (
          (
              MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
                  unknown,
              >
                  ? Promise<bigint>
                  : bigint
          ) extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )

  The parsed signed integer (as a bigint)

readSignedIntegerByte

• readSignedIntegerByte(): MaybePromise<number, IsAsync> extends Promise<unknown>
      ? Promise<number>
      : number

  Parse a signed integer from a byte

  Returns MaybePromise<number, IsAsync> extends Promise<unknown>
      ? Promise<number>
      : number

  The parsed signed integer

readSignedIntegerByteArray

• readSignedIntegerByteArray(
      bytes: number,
  ): (
      MaybePromise<number, IsAsync> extends Promise<unknown>
          ? Promise<number>
          : number
  ) extends Promise<unknown>
      ? Promise<
          AwaitedUnion<
              Promise<unknown> & (
                  MaybePromise<number, IsAsync> extends Promise<unknown>
                      ? Promise<number>
                      : number
              ),
          >[],
      >
      : (
          MaybePromise<number, IsAsync> extends Promise<unknown>
              ? Promise<number>
              : number
      )[]

  Parse a signed integer from a byte

  Parameters

  • bytes: number

  Returns (
      MaybePromise<number, IsAsync> extends Promise<unknown>
          ? Promise<number>
          : number
  ) extends Promise<unknown>
      ? Promise<
          AwaitedUnion<
              Promise<unknown> & (
                  MaybePromise<number, IsAsync> extends Promise<unknown>
                      ? Promise<number>
                      : number
              ),
          >[],
      >
      : (
          MaybePromise<number, IsAsync> extends Promise<unknown>
              ? Promise<number>
              : number
      )[]

  The parsed signed integers

readSignedOnesComplement

• readSignedOnesComplement(
      bytes: number,
  ):
      | (
          (
              MaybePromise<number[], IsAsync> extends Promise<unknown>
                  ? Promise<number>
                  : number
          ) extends Promise<unknown>
              ? Promise<number>
              : number
      )
      | (
          (
              MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
                  unknown,
              >
                  ? Promise<number>
                  : number
          ) extends Promise<unknown>
              ? Promise<number>
              : number
      )

  Parse a signed one's complement

  Parameters

  • bytes: number

    How long the signed one's complement is

  Returns
      | (
          (
              MaybePromise<number[], IsAsync> extends Promise<unknown>
                  ? Promise<number>
                  : number
          ) extends Promise<unknown>
              ? Promise<number>
              : number
      )
      | (
          (
              MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
                  unknown,
              >
                  ? Promise<number>
                  : number
          ) extends Promise<unknown>
              ? Promise<number>
              : number
      )

  The parsed signed ones compement

readSignedOnesComplementBigint

• readSignedOnesComplementBigint(
      bytes: number,
  ):
      | (
          (
              MaybePromise<number[], IsAsync> extends Promise<unknown>
                  ? Promise<bigint>
                  : bigint
          ) extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )
      | (
          (
              MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
                  unknown,
              >
                  ? Promise<bigint>
                  : bigint
          ) extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )

  Parse a signed one's complement as a bigint

  Parameters

  • bytes: number

    How long the signed one's complement is

  Returns
      | (
          (
              MaybePromise<number[], IsAsync> extends Promise<unknown>
                  ? Promise<bigint>
                  : bigint
          ) extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )
      | (
          (
              MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
                  unknown,
              >
                  ? Promise<bigint>
                  : bigint
          ) extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )

  The parsed signed ones compement (as a bigint)

readSignedOnesComplementByte

• readSignedOnesComplementByte(): MaybePromise<number, IsAsync> extends Promise<
      unknown,
  >
      ? Promise<number>
      : number

  Parse a signed one's complement from a byte

  Returns MaybePromise<number, IsAsync> extends Promise<unknown>
      ? Promise<number>
      : number

  The parsed signed one's compement

readSignedOnesComplementByteArray

• readSignedOnesComplementByteArray(
      bytes: number,
  ): (
      MaybePromise<number, IsAsync> extends Promise<unknown>
          ? Promise<number>
          : number
  ) extends Promise<unknown>
      ? Promise<
          AwaitedUnion<
              Promise<unknown> & (
                  MaybePromise<number, IsAsync> extends Promise<unknown>
                      ? Promise<number>
                      : number
              ),
          >[],
      >
      : (
          MaybePromise<number, IsAsync> extends Promise<unknown>
              ? Promise<number>
              : number
      )[]

  Parse signed one's complements (one byte each) from bytes

  Parameters

  • bytes: number

    How many one's complements to read

  Returns (
      MaybePromise<number, IsAsync> extends Promise<unknown>
          ? Promise<number>
          : number
  ) extends Promise<unknown>
      ? Promise<
          AwaitedUnion<
              Promise<unknown> & (
                  MaybePromise<number, IsAsync> extends Promise<unknown>
                      ? Promise<number>
                      : number
              ),
          >[],
      >
      : (
          MaybePromise<number, IsAsync> extends Promise<unknown>
              ? Promise<number>
              : number
      )[]

  The parsed signed one's compements

readString

• readString(
      bytes: number,
      mutf8?: boolean,
  ): MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
      unknown,
  >
      ? Promise<string>
      : string

  Parse a string

  Parameters

  • bytes: number

    How many bytes long the string is
  • Optionalmutf8: boolean = false

    If the string is mutf8

  Returns MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<unknown>
      ? Promise<string>
      : string

  The parsed string

readTwosComplement

• readTwosComplement(
      bytes: number,
  ):
      | (
          (
              MaybePromise<number[], IsAsync> extends Promise<unknown>
                  ? Promise<number>
                  : number
          ) extends Promise<unknown>
              ? Promise<number>
              : number
      )
      | (
          (
              MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
                  unknown,
              >
                  ? Promise<number>
                  : number
          ) extends Promise<unknown>
              ? Promise<number>
              : number
      )

  Parse a two's complement

  Parameters

  • bytes: number

    How many bytes it is

  Returns
      | (
          (
              MaybePromise<number[], IsAsync> extends Promise<unknown>
                  ? Promise<number>
                  : number
          ) extends Promise<unknown>
              ? Promise<number>
              : number
      )
      | (
          (
              MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
                  unknown,
              >
                  ? Promise<number>
                  : number
          ) extends Promise<unknown>
              ? Promise<number>
              : number
      )

  The parsed twos complement

readTwosComplementBigint

• readTwosComplementBigint(
      bytes: number,
  ):
      | (
          (
              MaybePromise<number[], IsAsync> extends Promise<unknown>
                  ? Promise<bigint>
                  : bigint
          ) extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )
      | (
          (
              MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
                  unknown,
              >
                  ? Promise<bigint>
                  : bigint
          ) extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )

  Parse a two's complement as a bigint

  Parameters

  • bytes: number

    How many bytes it is

  Returns
      | (
          (
              MaybePromise<number[], IsAsync> extends Promise<unknown>
                  ? Promise<bigint>
                  : bigint
          ) extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )
      | (
          (
              MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
                  unknown,
              >
                  ? Promise<bigint>
                  : bigint
          ) extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )

  The parsed twos complement (as a bigint)

readTwosComplementByte

• readTwosComplementByte(): MaybePromise<number, IsAsync> extends Promise<unknown>
      ? Promise<number>
      : number

  Parse a two's complement from a single byte

  Returns MaybePromise<number, IsAsync> extends Promise<unknown>
      ? Promise<number>
      : number

  The parsed twos complement

readTwosComplementByteArray

• readTwosComplementByteArray(
      bytes: number,
  ): (
      MaybePromise<number, IsAsync> extends Promise<unknown>
          ? Promise<number>
          : number
  ) extends Promise<unknown>
      ? Promise<
          AwaitedUnion<
              Promise<unknown> & (
                  MaybePromise<number, IsAsync> extends Promise<unknown>
                      ? Promise<number>
                      : number
              ),
          >[],
      >
      : (
          MaybePromise<number, IsAsync> extends Promise<unknown>
              ? Promise<number>
              : number
      )[]

  Parse a two's complements from single bytes

  Parameters

  • bytes: number

    How many two's complements to parse

  Returns (
      MaybePromise<number, IsAsync> extends Promise<unknown>
          ? Promise<number>
          : number
  ) extends Promise<unknown>
      ? Promise<
          AwaitedUnion<
              Promise<unknown> & (
                  MaybePromise<number, IsAsync> extends Promise<unknown>
                      ? Promise<number>
                      : number
              ),
          >[],
      >
      : (
          MaybePromise<number, IsAsync> extends Promise<unknown>
              ? Promise<number>
              : number
      )[]

  The parsed twos complements

AbstractreadUint8Array

• readUint8Array(
      bytes: number,
  ): MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync>

  Read a Uint8Array from the start of the buffer

  Parameters

  • bytes: number

    How many bytes to read

  Returns MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync>

AbstractreadUint8ArrayBackwards

• readUint8ArrayBackwards(
      bytes: number,
  ): MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync>

  Read a Uint8Array from the start of the buffer backwards

  Parameters

  • bytes: number

    How many bytes to read

  Returns MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync>

readUnsignedInt

• readUnsignedInt(
      bytes: number,
  ):
      | (
          MaybePromise<number[], IsAsync> extends Promise<unknown>
              ? Promise<number>
              : number
      )
      | (
          MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
              unknown,
          >
              ? Promise<number>
              : number
      )

  Read a unsigned integer

  Parameters

  • bytes: number

    How many bytes the data is

  Returns
      | (
          MaybePromise<number[], IsAsync> extends Promise<unknown>
              ? Promise<number>
              : number
      )
      | (
          MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
              unknown,
          >
              ? Promise<number>
              : number
      )

  The parsed unsigned integer

readUnsignedIntBigint

• readUnsignedIntBigint(
      bytes: number,
  ):
      | (
          MaybePromise<number[], IsAsync> extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )
      | (
          MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
              unknown,
          >
              ? Promise<bigint>
              : bigint
      )

  Read a unsigned integer as a bigint

  Parameters

  • bytes: number

    How many bytes the data is

  Returns
      | (
          MaybePromise<number[], IsAsync> extends Promise<unknown>
              ? Promise<bigint>
              : bigint
      )
      | (
          MaybePromise<Uint8Array<ArrayBufferLike>, IsAsync> extends Promise<
              unknown,
          >
              ? Promise<bigint>
              : bigint
      )

  The parsed unsigned integer (as a bigint)

Abstractshift

• shift(): MaybePromise<number, IsAsync>

  Read from the start of the buffer

  Returns MaybePromise<number, IsAsync>