Interface BigIntBuffer2

Core API interface matching bigint-buffer's function signatures.

interface BigIntBuffer2 {
    toBigIntBE(
        buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    ): bigint;
    toBigIntBESigned(
        buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    ): bigint;
    toBigIntLE(
        buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    ): bigint;
    toBigIntLESigned(
        buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    ): bigint;
    toBufferBE(
        num: bigint,
        width: number,
    ): Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>;
    toBufferLE(
        num: bigint,
        width: number,
    ): Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>;
}

Hierarchy (View Summary)

Methods

toBigIntBE toBigIntBESigned toBigIntLE toBigIntLESigned toBufferBE toBufferLE

Methods

toBigIntBE

  • toBigIntBE(
        buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    ): bigint

    Convert a big-endian buffer to BigInt (unsigned).

    Parameters

    • buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

      Big-endian byte buffer

    Returns bigint

    BigInt value (always positive)

toBigIntBESigned

  • toBigIntBESigned(
        buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    ): bigint

    Convert a big-endian buffer to signed BigInt using two's complement.

    Parameters

    • buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

      Big-endian byte buffer

    Returns bigint

    BigInt value (can be negative)

toBigIntLE

  • toBigIntLE(
        buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    ): bigint

    Convert a little-endian buffer to BigInt (unsigned).

    Parameters

    • buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

      Little-endian byte buffer

    Returns bigint

    BigInt value (always positive)

toBigIntLESigned

  • toBigIntLESigned(
        buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>,
    ): bigint

    Convert a little-endian buffer to signed BigInt using two's complement.

    Parameters

    • buffer: Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

      Little-endian byte buffer

    Returns bigint

    BigInt value (can be negative)

toBufferBE

  • toBufferBE(
        num: bigint,
        width: number,
    ): Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

    Convert BigInt to big-endian buffer with specified width.

    Parameters

    • num: bigint

      BigInt value to convert

    • width: number

      Desired buffer width in bytes

    Returns Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

    Big-endian buffer of exactly width bytes

toBufferLE

  • toBufferLE(
        num: bigint,
        width: number,
    ): Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

    Convert BigInt to little-endian buffer with specified width.

    Parameters

    • num: bigint

      BigInt value to convert

    • width: number

      Desired buffer width in bytes

    Returns Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

    Little-endian buffer of exactly width bytes

Settings

Member Visibility

On This Page

Methods