Interface UncheckedConverter

UncheckedConverter is a set of functions that convert numbers to Uint8Array and vice versa. Implementation should not directly check for overflows or underflows.

This is a low-level interface, and it is not recommended to use it directly. Instead, use BigIntConverter. One possible use case of an UncheckedConverter is for performance reasons, when you are sure that the input is within the boundaries.

interface UncheckedConverter {
    arrayToBigEndian(buf): bigint;
    arrayToLittleEndian(buf): bigint;
    bigEndianToArray(num, dest): void;
    bigEndianToNewArray(num, bytes): Uint8Array;
    littleEndianToArray(num, dest): void;
    littleEndianToNewArray(num, bytes): Uint8Array;
}

Methods

arrayToBigEndian arrayToLittleEndian bigEndianToArray bigEndianToNewArray littleEndianToArray littleEndianToNewArray

Methods

arrayToBigEndian

  • arrayToBigEndian(buf): bigint

  • Converts Uint8Array into number in BigEndian format

    Parameters

    • buf: Uint8Array

      Uint8Array to convert

    Returns bigint

    bigint

arrayToLittleEndian

  • arrayToLittleEndian(buf): bigint

  • Converts Uint8Array into number in LittleEndian format

    Parameters

    • buf: Uint8Array

      Uint8Array to convert

    Returns bigint

    bigint

bigEndianToArray

  • bigEndianToArray(num, dest): void

  • Converts number into Uint8Array in BigEndian format

    Parameters

    • num: bigint

      the number to convert

    • dest: Uint8Array

      the destination buffer

    Returns void

    See

    bigEndianToNewArray - similar to bigEndianToNewArray, but writes to the destination buffer instead of returning a new one

    Throws

    • it may throw if the buffer is too small

bigEndianToNewArray

  • bigEndianToNewArray(num, bytes): Uint8Array

  • Converts number into Uint8Array in BigEndian format

    Parameters

    • num: bigint

      number to convert

    • bytes: number

      number of bytes to use

    Returns Uint8Array

    Uint8Array

littleEndianToArray

  • littleEndianToArray(num, dest): void

  • Converts number into Uint8Array in LittleEndian format

    Parameters

    • num: bigint

      the number to convert

    • dest: Uint8Array

      the destination buffer

    Returns void

    See

    littleEndianToNewArray - similar, but writes to the destination buffer instead

littleEndianToNewArray

  • littleEndianToNewArray(num, bytes): Uint8Array

  • Converts number into Uint8Array in LittleEndian format

    Parameters

    • num: bigint

      the number to convert

    • bytes: number

      number of bytes to use

    Returns Uint8Array

Settings

Member Visibility

Theme

On This Page

arrayToBigEndianarrayToLittleEndianbigEndianToArraybigEndianToNewArraylittleEndianToArraylittleEndianToNewArray

Generated using TypeDoc