Interface Buffer

Polyfill for BigInt support in Buffer

Example

import '@vekexasia/bigint-buffer-polyfill';

const buf = Buffer.alloc(16);
buf.writeBigIntBE(-42n, 8);
buf.writeBigUIntLE(69n, 8, 8);

console.log(buf.readBigIntBE(8)); // -42n
console.log(buf.readBigUIntLE(8, 8)); // 69n
interface Buffer {
    readBigIntBE(width, offset?): bigint;
    readBigIntLE(width, offset?): bigint;
    readBigUIntBE(width, offset?): bigint;
    readBigUIntLE(width, offset?): bigint;
    writeBigIntBE(value, width, offset?): number;
    writeBigIntLE(value, width, offset?): number;
    writeBigUIntBE(value, width, offset?): number;
    writeBigUIntLE(value, width, offset?): number;
}

Methods

readBigIntBE readBigIntLE readBigUIntBE readBigUIntLE writeBigIntBE writeBigIntLE writeBigUIntBE writeBigUIntLE

Methods

readBigIntBE

  • readBigIntBE(width, offset?): bigint

  • Read a signed BigInt from a buffer in Big Endian format

    Parameters

    • width: number

      the number of bytes to read

    • Optional offset: number

      the offset to read from

    Returns bigint

    the value read

readBigIntLE

  • readBigIntLE(width, offset?): bigint

  • Read a signed BigInt from a buffer in Little Endian format

    Parameters

    • width: number

      the number of bytes to read

    • Optional offset: number

      the offset to read from

    Returns bigint

    the value read

readBigUIntBE

  • readBigUIntBE(width, offset?): bigint

  • Read an unsigned BigInt from a buffer in Big Endian format

    Parameters

    • width: number

      the number of bytes to read

    • Optional offset: number

      the offset to read from

    Returns bigint

    the value read

readBigUIntLE

  • readBigUIntLE(width, offset?): bigint

  • Read an unsigned BigInt from a buffer in Little Endian format

    Parameters

    • width: number

      the number of bytes to read

    • Optional offset: number

      the offset to read from

    Returns bigint

    the value read

writeBigIntBE

  • writeBigIntBE(value, width, offset?): number

  • Write a signed BigInt to a buffer in Big Endian format

    Parameters

    • value: bigint

      the value to write

    • width: number

      the number of bytes to write

    • Optional offset: number

      the offset to write at

    Returns number

    the number of bytes written

writeBigIntLE

  • writeBigIntLE(value, width, offset?): number

  • Write a signed BigInt to a buffer in Little Endian format

    Parameters

    • value: bigint

      the value to write

    • width: number

      the number of bytes to write

    • Optional offset: number

      the offset to write at

    Returns number

    the number of bytes written

writeBigUIntBE

  • writeBigUIntBE(value, width, offset?): number

  • Write an unsigned BigInt to a buffer in Big Endian format

    Parameters

    • value: bigint

      the value to write

    • width: number

      the number of bytes to write

    • Optional offset: number

      the offset to write at

    Returns number

    the number of bytes written

writeBigUIntLE

  • writeBigUIntLE(value, width, offset?): number

  • Write an unsigned BigInt to a buffer in Little Endian format

    Parameters

    • value: bigint

      the value to write

    • width: number

      the number of bytes to write

    • Optional offset: number

      the offset to write at

    Returns number

    the number of bytes written

Settings

Member Visibility

Theme

On This Page

readBigIntBEreadBigIntLEreadBigUIntBEreadBigUIntLEwriteBigIntBEwriteBigIntLEwriteBigUIntBEwriteBigUIntLE

Generated using TypeDoc