bireader 3.1.1 → 3.1.3

package/dist/core/BiBase.d.ts

@@ -1,46 +1,5 @@
 /// <reference types="node" />
 import { endian, hexdumpOptions, stringOptions } from '../common.js';
-export declare function hexDumpBase(ctx: BiBase, options?: hexdumpOptions): string;
-export declare function skip(ctx: BiBase, bytes: number, bits?: number): void;
-export declare function align(ctx: BiBase, n: number): void;
-export declare function alignRev(ctx: BiBase, n: number): void;
-export declare function goto(ctx: BiBase, bytes: number, bits?: number): void;
-export declare function check_size(ctx: BiBase, write_bytes: number, write_bit?: number, offset?: number): number;
-export declare function checkSize(ctx: BiBase, write_bytes: number, write_bit?: number, offset?: number): number;
-export declare function extendarray(ctx: BiBase, to_padd: number): void;
-export declare function remove(ctx: BiBase, startOffset?: number, endOffset?: number, consume?: boolean, remove?: boolean, fillValue?: number): any;
-export declare function addData(ctx: BiBase, data: Buffer | Uint8Array, consume?: boolean, offset?: number, replace?: boolean): void;
-export declare function AND(ctx: BiBase, and_key: any, start?: number, end?: number, consume?: boolean): any;
-export declare function OR(ctx: BiBase, or_key: any, start?: number, end?: number, consume?: boolean): any;
-export declare function XOR(ctx: BiBase, xor_key: any, start?: number, end?: number, consume?: boolean): any;
-export declare function NOT(ctx: BiBase, start?: number, end?: number, consume?: boolean): any;
-export declare function LSHIFT(ctx: BiBase, shift_key: any, start?: number, end?: number, consume?: boolean): any;
-export declare function RSHIFT(ctx: BiBase, shift_key: any, start?: number, end?: number, consume?: boolean): any;
-export declare function ADD(ctx: BiBase, add_key: any, start?: number, end?: number, consume?: boolean): any;
-export declare function fString(ctx: BiBase, searchString: string): number;
-export declare function fNumber(ctx: BiBase, targetNumber: number, bits: number, unsigned: boolean, endian?: string): number;
-export declare function fHalfFloat(ctx: BiBase, targetNumber: number, endian?: string): number;
-export declare function fFloat(ctx: BiBase, targetNumber: number, endian?: string): number;
-export declare function fBigInt(ctx: BiBase, targetNumber: number, unsigned: boolean, endian?: string): number;
-export declare function fDoubleFloat(ctx: BiBase, targetNumber: number, endian?: string): number;
-export declare function wbit(ctx: BiBase, value: number, bits: number, unsigned?: boolean, endian?: string): void;
-export declare function rbit(ctx: BiBase, bits?: number, unsigned?: boolean, endian?: string): number;
-export declare function wbyte(ctx: BiBase, value: number, unsigned?: boolean): void;
-export declare function rbyte(ctx: BiBase, unsigned?: boolean): number;
-export declare function wint16(ctx: BiBase, value: number, unsigned?: boolean, endian?: string): void;
-export declare function rint16(ctx: BiBase, unsigned?: boolean, endian?: string): number;
-export declare function rhalffloat(ctx: BiBase, endian?: endian): number;
-export declare function whalffloat(ctx: BiBase, value: number, endian?: string): void;
-export declare function wint32(ctx: BiBase, value: number, unsigned?: boolean, endian?: string): void;
-export declare function rint32(ctx: BiBase, unsigned?: boolean, endian?: string): number;
-export declare function rfloat(ctx: BiBase, endian?: endian): number;
-export declare function wfloat(ctx: BiBase, value: number, endian?: string): void;
-export declare function rint64(ctx: BiBase, unsigned?: boolean, endian?: string): bigint;
-export declare function wint64(ctx: BiBase, value: number, unsigned?: boolean, endian?: string): void;
-export declare function wdfloat(ctx: BiBase, value: number, endian?: string): void;
-export declare function rdfloat(ctx: BiBase, endian?: endian): number;
-export declare function rstring(ctx: BiBase, options?: stringOptions): string;
-export declare function wstring(ctx: BiBase, string: string, options?: stringOptions): void;
 export declare class BiBase {
     /**
      * Endianness of default read.
@@ -73,9 +32,9 @@ export declare class BiBase {
     errorDump: boolean;
     /**
      * Current buffer data.
-     * @type {Buffer|Uint8Array}
+     * @type {Buffer|Uint8Array|null}
      */
-    data: any;
+    data: Buffer | Uint8Array | null;
     /**
      * When the data buffer needs to be extended while strict mode is ``false``, this will be the amount it extends.
      *
@@ -86,18 +45,53 @@ export declare class BiBase {
      * NOTE: Using ``BiWriter.get`` or ``BiWriter.return`` will now remove all data after the current write position. Use ``BiWriter.data`` to get the full buffer instead.
      */
     extendBufferSize: number;
+    fd: any;
+    filePath: string;
+    fsMode: string;
     /**
      * The settings that used when using the .str getter / setter
      */
     private strDefaults;
+    maxFileSize: number | null;
+    constructor();
     /**
      * Settings for when using .str
      *
      * @param {stringOptions} settings options to use with .str
      */
     set strSettings(settings: stringOptions);
-    isBufferOrUint8Array(obj: Buffer | Uint8Array): boolean;
+    /**
+     * Enables expanding in reader (changes strict)
+     *
+     * @param {boolean} mode - Enable expanding in reader (changes strict)
+     */
+    writeMode(mode: boolean): void;
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    open(): number;
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    updateSize(): void;
+    /**
+     * removes data.
+     */
+    close(): void;
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    read(start: number, length: number, consume?: boolean): Buffer | Uint8Array;
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    write(start: number, data: Buffer, consume?: boolean): number;
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    commit(consume?: boolean): number;
     extendArray(to_padd: number): void;
+    isBufferOrUint8Array(obj: Buffer | Uint8Array): boolean;
     /**
      *
      * Change endian, defaults to little.
@@ -338,10 +332,6 @@ export declare class BiBase {
      * removes data.
      */
     end(): void;
-    /**
-     * removes data.
-     */
-    close(): void;
     /**
      * removes data.
      */
@@ -403,11 +393,11 @@ export declare class BiBase {
      *
      * Does not change current read position.
      *
-     * @param {number} value - Number to search for.
+     * @param {number|bigint} value - Number to search for.
      * @param {boolean} unsigned - If the number is unsigned (default true)
      * @param {endian} endian - endianness of value (default set endian).
      */
-    findInt64(value: number, unsigned?: boolean, endian?: endian): number;
+    findInt64(value: number | bigint, unsigned?: boolean, endian?: endian): number;
     /**
      * Searches for half float value position from current read position.
      *
@@ -1199,76 +1189,76 @@ export declare class BiBase {
      *
      * @param {boolean} unsigned - if value is unsigned or not
      * @param {endian?} endian - ``big`` or ``little``
-     * @returns {number}
+     * @returns {bigint}
      */
     readInt64(unsigned?: boolean, endian?: endian): bigint;
     /**
      * Write 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      * @param {boolean} unsigned - if the value is unsigned
      * @param {endian} endian - ``big`` or ``little``
      */
-    writeInt64(value: number, unsigned?: boolean, endian?: endian): void;
+    writeInt64(value: number | bigint, unsigned?: boolean, endian?: endian): void;
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      * @param {endian} endian - ``big`` or ``little``
      */
-    writeUInt64(value: number, endian?: endian): void;
+    writeUInt64(value: number | bigint, endian?: endian): void;
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    writeInt64LE(value: number): void;
+    writeInt64LE(value: number | bigint): void;
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    writeUInt64LE(value: number): void;
+    writeUInt64LE(value: number | bigint): void;
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    writeInt64BE(value: number): void;
+    writeInt64BE(value: number | bigint): void;
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    writeUInt64BE(value: number): void;
+    writeUInt64BE(value: number | bigint): void;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     readUInt64(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     readInt64BE(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     readUInt64BE(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     readInt64LE(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     readUInt64LE(): bigint;
     /**

package/dist/core/BiBaseStream.d.ts

@@ -42,7 +42,7 @@ export declare class BiBaseStreamer {
     /**
      * Current buffer chunk.
      *
-     * @type {Buffer}
+     * @type {Buffer|null}
      */
     data: Buffer | null;
     /**
@@ -336,15 +336,15 @@ export declare class BiBaseStreamer {
      */
     get return(): Buffer;
     /**
- * Creates hex dump string. Will console log or return string if set in options.
- *
- * @param {object} options
- * @param {hexdumpOptions?} options - hex dump options
- * @param {number?} options.length - number of bytes to log, default ``192`` or end of data
- * @param {number?} options.startByte - byte to start dump (default ``0``)
- * @param {boolean?} options.supressUnicode - Supress unicode character preview for even columns.
- * @param {boolean?} options.returnString - Returns the hex dump string instead of logging it.
- */
+     * Creates hex dump string. Will console log or return string if set in options.
+     *
+     * @param {object} options
+     * @param {hexdumpOptions?} options - hex dump options
+     * @param {number?} options.length - number of bytes to log, default ``192`` or end of data
+     * @param {number?} options.startByte - byte to start dump (default ``0``)
+     * @param {boolean?} options.supressUnicode - Supress unicode character preview for even columns.
+     * @param {boolean?} options.returnString - Returns the hex dump string instead of logging it.
+     */
     hexdump(options?: hexdumpOptions): void | string;
     /**
      * Turn hexdump on error off (default on).
@@ -427,11 +427,11 @@ export declare class BiBaseStreamer {
      *
      * Does not change current read position.
      *
-     * @param {number} value - Number to search for.
+     * @param {number|bigint} value - Number to search for.
      * @param {boolean} unsigned - If the number is unsigned (default true)
      * @param {endian} endian - endianness of value (default set endian).
      */
-    findInt64(value: number, unsigned?: boolean, endian?: endian): number;
+    findInt64(value: number | bigint, unsigned?: boolean, endian?: endian): number;
     /**
      * Searches for half float value position from current read position.
      *
@@ -1223,76 +1223,76 @@ export declare class BiBaseStreamer {
      *
      * @param {boolean} unsigned - if value is unsigned or not
      * @param {endian?} endian - ``big`` or ``little``
-     * @returns {number}
+     * @returns {bigint}
      */
     readInt64(unsigned?: boolean, endian?: endian): bigint;
     /**
      * Write 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      * @param {boolean} unsigned - if the value is unsigned
      * @param {endian} endian - ``big`` or ``little``
      */
-    writeInt64(value: number, unsigned?: boolean, endian?: endian): void;
+    writeInt64(value: number | bigint, unsigned?: boolean, endian?: endian): void;
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      * @param {endian} endian - ``big`` or ``little``
      */
-    writeUInt64(value: number, endian?: endian): void;
+    writeUInt64(value: number | bigint, endian?: endian): void;
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    writeInt64LE(value: number): void;
+    writeInt64LE(value: number | bigint): void;
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    writeUInt64LE(value: number): void;
+    writeUInt64LE(value: number | bigint): void;
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    writeInt64BE(value: number): void;
+    writeInt64BE(value: number | bigint): void;
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    writeUInt64BE(value: number): void;
+    writeUInt64BE(value: number | bigint): void;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     readUInt64(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     readInt64BE(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     readUInt64BE(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     readInt64LE(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     readUInt64LE(): bigint;
     /**