com.hydroper.util.nodejsbytearray v1.1.1

NodeJS byte array

Growable byte array for Node.js.

Installation

npm i com.hydroper.util.nodejsbytearray

Basic Usage

import ByteArray, {Endian} from 'com.hydroper.util.nodejsbytearray';

let ba = new ByteArray;
ba.endian = 'littleEndian';
ba.writeUTF8('foo');
ba.position = 0;
console.log(ba.readUTF8(3)); // foo

API

export type Endian = 'littleEndian' | 'bigEndian';

export declare default class ByteArray {
    constructor();

    static from(argument: ByteArray | Buffer): ByteArray;
    static withCapacity(initialCapacity: number): ByteArray;
    static withZeroes(length: number): ByteArray;

    toNodejsBuffer(): Buffer;
    *[Symbol.iterator](): Generator<number>;

    endian: Endian;
    position: number;
    length: number;
    readonly bytesAvailable: number;
    readonly hasBytesAvailable: boolean;

    /**
     * Clears the array. `keepCapacity` is false by default.
     */
    clear(keepCapacity?: boolean);

    equals(other: ByteArray): boolean;
    at(position: number): number;
    set(position: number, value: number);

    /**
     * Reads unsigned byte.
     */
    readByte(): number;

    /**
     * Writes unsigned byte.
     */
    writeByte(value: number);

    readSignedByte(): number;
    writeSignedByte(value: number);

    readShort(): number;
    writeShort(value: number);

    readUnsignedShort(): number;
    writeUnsignedShort(value: number);

    readInt(): number;
    writeInt(value: number);

    readUnsignedInt(): number;
    writeUnsignedInt(value: number);

    readLong(): bigint;
    writeLong(value: bigint);

    readUnsignedLong(): bigint;
    writeUnsignedLong(value: bigint);

    readFloat(): number;
    writeFloat(value: number);

    readDouble(): number;
    writeDouble(value: number);

    readUTF8(length: number): string;
    writeUTF8(value: string);

    readBytes(length: number): ByteArray;
    writeBytes(value: ByteArray);
}