bireader 3.1.1 → 3.1.3

package/dist/index.esm.d.ts

@@ -118,9 +118,9 @@ 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.
      *
@@ -131,18 +131,53 @@ 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.
@@ -383,10 +418,6 @@ declare class BiBase {
      * removes data.
      */
     end(): void;
-    /**
-     * removes data.
-     */
-    close(): void;
     /**
      * removes data.
      */
@@ -448,11 +479,11 @@ 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.
      *
@@ -1244,76 +1275,76 @@ 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;
     /**
@@ -1424,7 +1455,7 @@ declare class BiBaseStreamer {
     /**
      * Current buffer chunk.
      *
-     * @type {Buffer}
+     * @type {Buffer|null}
      */
     data: Buffer | null;
     /**
@@ -1718,15 +1749,15 @@ 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).
@@ -1809,11 +1840,11 @@ 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.
      *
@@ -2605,76 +2636,76 @@ 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;
     /**
@@ -4672,109 +4703,109 @@ interface BinaryAliasReader extends BiBase {
     /**
      * Read signed 64 bit integer
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get int64(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get bigint(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get quad(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get uint64(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get ubigint(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get uquad(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get int64be(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get bigintbe(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get quadbe(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get uint64be(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get ubigintbe(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get uquadbe(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get int64le(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get bigintle(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get quadle(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get uint64le(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get ubigintle(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get uquadle(): bigint;
     /**
@@ -7009,109 +7040,109 @@ interface BinaryAliasReaderStreamer extends BiBaseStreamer {
     /**
      * Read signed 64 bit integer
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get int64(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get bigint(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get quad(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get uint64(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get ubigint(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get uquad(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get int64be(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get bigintbe(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get quadbe(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get uint64be(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get ubigintbe(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get uquadbe(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get int64le(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get bigintle(): bigint;
     /**
      * Read signed 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get quadle(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get uint64le(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get ubigintle(): bigint;
     /**
      * Read unsigned 64 bit integer.
      *
-     * @returns {number}
+     * @returns {bigint}
      */
     get uquadle(): bigint;
     /**
@@ -9694,111 +9725,111 @@ interface BinaryAliasWriter extends BiBase {
     /**
      * Write 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set int64(value: number);
+    set int64(value: number | bigint);
     /**
     * Write 64 bit integer.
     *
-    * @param {number} value - value as int
+    * @param {number|bigint} value - value as int
     */
-    set quad(value: number);
+    set quad(value: number | bigint);
     /**
      * Write 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set bigint(value: number);
+    set bigint(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set uint64(value: number);
+    set uint64(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set ubigint(value: number);
+    set ubigint(value: number | bigint);
     /**
     * Write unsigned 64 bit integer.
     *
-    * @param {number} value - value as int
+    * @param {number|bigint} value - value as int
     */
-    set uquad(value: number);
+    set uquad(value: number | bigint);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set int64le(value: number);
+    set int64le(value: number | bigint);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set bigintle(value: number);
+    set bigintle(value: number | bigint);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set quadle(value: number);
+    set quadle(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set uint64le(value: number);
+    set uint64le(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set ubigintle(value: number);
+    set ubigintle(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set uquadle(value: number);
+    set uquadle(value: number | bigint);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set int64be(value: number);
+    set int64be(value: number | bigint);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set bigintbe(value: number);
+    set bigintbe(value: number | bigint);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set quadbe(value: number);
+    set quadbe(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set uint64be(value: number);
+    set uint64be(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set ubigintbe(value: number);
+    set ubigintbe(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set uquadbe(value: number);
+    set uquadbe(value: number | bigint);
     /**
      * Writes double float.
      *
@@ -12016,111 +12047,111 @@ interface BinaryAliasWriterStreamer extends BiBaseStreamer {
     /**
      * Write 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set int64(value: number);
+    set int64(value: number | bigint);
     /**
     * Write 64 bit integer.
     *
-    * @param {number} value - value as int
+    * @param {number|bigint} value - value as int
     */
-    set quad(value: number);
+    set quad(value: number | bigint);
     /**
      * Write 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set bigint(value: number);
+    set bigint(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set uint64(value: number);
+    set uint64(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set ubigint(value: number);
+    set ubigint(value: number | bigint);
     /**
     * Write unsigned 64 bit integer.
     *
-    * @param {number} value - value as int
+    * @param {number|bigint} value - value as int
     */
-    set uquad(value: number);
+    set uquad(value: number | bigint);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set int64le(value: number);
+    set int64le(value: number | bigint);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set bigintle(value: number);
+    set bigintle(value: number | bigint);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set quadle(value: number);
+    set quadle(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set uint64le(value: number);
+    set uint64le(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set ubigintle(value: number);
+    set ubigintle(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set uquadle(value: number);
+    set uquadle(value: number | bigint);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set int64be(value: number);
+    set int64be(value: number | bigint);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set bigintbe(value: number);
+    set bigintbe(value: number | bigint);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set quadbe(value: number);
+    set quadbe(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set uint64be(value: number);
+    set uint64be(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set ubigintbe(value: number);
+    set ubigintbe(value: number | bigint);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number} value - value as int
+     * @param {number|bigint} value - value as int
      */
-    set uquadbe(value: number);
+    set uquadbe(value: number | bigint);
     /**
      * Writes double float.
      *