Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @stablelib/binary

Index

Functions

  • readFloat32BE(array: Uint8Array, offset?: number): number
  • Reads 4 bytes from array starting at offset as big-endian 32-bit floating-point number and returns it.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readFloat32LE(array: Uint8Array, offset?: number): number
  • Reads 4 bytes from array starting at offset as little-endian 32-bit floating-point number and returns it.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readFloat64BE(array: Uint8Array, offset?: number): number
  • Reads 8 bytes from array starting at offset as big-endian 64-bit floating-point number ("double") and returns it.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readFloat64LE(array: Uint8Array, offset?: number): number
  • Reads 8 bytes from array starting at offset as little-endian 64-bit floating-point number ("double") and returns it.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readInt16BE(array: Uint8Array, offset?: number): number
  • Reads 2 bytes from array starting at offset as big-endian signed 16-bit integer and returns it.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readInt16LE(array: Uint8Array, offset?: number): number
  • Reads 2 bytes from array starting at offset as little-endian signed 16-bit integer and returns it.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readInt32BE(array: Uint8Array, offset?: number): number
  • Reads 4 bytes from array starting at offset as big-endian signed 32-bit integer and returns it.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readInt32LE(array: Uint8Array, offset?: number): number
  • Reads 4 bytes from array starting at offset as little-endian signed 32-bit integer and returns it.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readInt64BE(array: Uint8Array, offset?: number): number
  • Reads 8 bytes from array starting at offset as big-endian signed 64-bit integer and returns it.

    IMPORTANT: due to JavaScript limitation, supports exact numbers in range -9007199254740991 to 9007199254740991. If the number stored in the byte array is outside this range, the result is not exact.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readInt64LE(array: Uint8Array, offset?: number): number
  • Reads 8 bytes from array starting at offset as little-endian signed 64-bit integer and returns it.

    IMPORTANT: due to JavaScript limitation, supports exact numbers in range -9007199254740991 to 9007199254740991. If the number stored in the byte array is outside this range, the result is not exact.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readUint16BE(array: Uint8Array, offset?: number): number
  • Reads 2 bytes from array starting at offset as big-endian unsigned 16-bit integer and returns it.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readUint16LE(array: Uint8Array, offset?: number): number
  • Reads 2 bytes from array starting at offset as little-endian unsigned 16-bit integer and returns it.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readUint32BE(array: Uint8Array, offset?: number): number
  • Reads 4 bytes from array starting at offset as big-endian unsigned 32-bit integer and returns it.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readUint32LE(array: Uint8Array, offset?: number): number
  • Reads 4 bytes from array starting at offset as little-endian unsigned 32-bit integer and returns it.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readUint64BE(array: Uint8Array, offset?: number): number
  • Reads 8 bytes from array starting at offset as big-endian unsigned 64-bit integer and returns it.

    IMPORTANT: due to JavaScript limitation, supports values up to 2^53-1.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readUint64LE(array: Uint8Array, offset?: number): number
  • Reads 8 bytes from array starting at offset as little-endian unsigned 64-bit integer and returns it.

    IMPORTANT: due to JavaScript limitation, supports values up to 2^53-1.

    Parameters

    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readUintBE(bitLength: number, array: Uint8Array, offset?: number): number
  • Reads bytes from array starting at offset as big-endian unsigned bitLen-bit integer and returns it.

    Supports bit lengths divisible by 8, up to 48.

    Parameters

    • bitLength: number
    • array: Uint8Array
    • offset: number = 0

    Returns number

  • readUintLE(bitLength: number, array: Uint8Array, offset?: number): number
  • Reads bytes from array starting at offset as little-endian unsigned bitLen-bit integer and returns it.

    Supports bit lengths divisible by 8, up to 48.

    Parameters

    • bitLength: number
    • array: Uint8Array
    • offset: number = 0

    Returns number

  • writeFloat32BE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Writes 4-byte big-endian floating-point representation of value to byte array starting at offset.

    If byte array is not given, creates a new 4-byte one.

    Returns the output byte array.

    Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeFloat32LE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Writes 4-byte little-endian floating-point representation of value to byte array starting at offset.

    If byte array is not given, creates a new 4-byte one.

    Returns the output byte array.

    Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeFloat64BE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Writes 8-byte big-endian floating-point representation of value to byte array starting at offset.

    If byte array is not given, creates a new 8-byte one.

    Returns the output byte array.

    Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeFloat64LE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Writes 8-byte little-endian floating-point representation of value to byte array starting at offset.

    If byte array is not given, creates a new 8-byte one.

    Returns the output byte array.

    Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeInt16BE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeInt16LE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeInt32BE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeInt32LE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeInt64BE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeInt64LE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeUint16BE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Writes 2-byte big-endian representation of 16-bit unsigned value to byte array starting at offset.

    If byte array is not given, creates a new 2-byte one.

    Returns the output byte array.

    Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeUint16LE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Writes 2-byte little-endian representation of 16-bit unsigned value to array starting at offset.

    If byte array is not given, creates a new 2-byte one.

    Returns the output byte array.

    Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeUint32BE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Writes 4-byte big-endian representation of 32-bit unsigned value to byte array starting at offset.

    If byte array is not given, creates a new 4-byte one.

    Returns the output byte array.

    Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeUint32LE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Writes 4-byte little-endian representation of 32-bit unsigned value to array starting at offset.

    If byte array is not given, creates a new 4-byte one.

    Returns the output byte array.

    Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeUint64BE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Writes 8-byte big-endian representation of 64-bit unsigned value to byte array starting at offset.

    Due to JavaScript limitation, supports values up to 2^53-1.

    If byte array is not given, creates a new 8-byte one.

    Returns the output byte array.

    Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeUint64LE(value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Writes 8-byte little-endian representation of 64-bit unsigned value to byte array starting at offset.

    Due to JavaScript limitation, supports values up to 2^53-1.

    If byte array is not given, creates a new 8-byte one.

    Returns the output byte array.

    Parameters

    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeUintBE(bitLength: number, value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Writes a big-endian representation of bitLen-bit unsigned value to array starting at offset.

    Supports bit lengths divisible by 8, up to 48.

    If byte array is not given, creates a new one.

    Returns the output byte array.

    Parameters

    • bitLength: number
    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

  • writeUintLE(bitLength: number, value: number, out?: Uint8Array, offset?: number): Uint8Array
  • Writes a little-endian representation of bitLen-bit unsigned value to array starting at offset.

    Supports bit lengths divisible by 8, up to 48.

    If byte array is not given, creates a new one.

    Returns the output byte array.

    Parameters

    • bitLength: number
    • value: number
    • out: Uint8Array = ...
    • offset: number = 0

    Returns Uint8Array

Generated using TypeDoc