bireader 3.1.1 → 3.1.2

package/README.md

@@ -793,7 +793,7 @@ With 3.1 you can now use ``BiReaderStream`` and ``BiWriterStream`` in Node for l
 
 ### Streaming Caveats
 
- * Naming: Same naming applies to streamers as [Common Functions](#common-functions) section but the file is saved after every operation.
+ * Naming: Same function naming applies to streamers as [Common Functions](#common-functions) section but the file is saved after every operation. **BiReaderStream / BiReader** and **BiWriterStream / BiWriter** are interchangeable when it comes to all functions and class objects names for easy use with type script.
  * Writing: Unlike the other BiReader, **all write functions will throw an error unless you switch to ``.writeMode(true)``** The file is read only until you do. Any write functions inside the reader will error beforehand.
  * Large removal: When using any function that removes data from the file and would return a Buffer, **if the size of the returned Buffer is outside of the Node max size for a Buffer, a new file will be made with the location and size concat to the name with a .removed file extention instead.**
 

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.
      */

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).

package/dist/index.browser.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.
      */

package/dist/index.browser.js

@@ -1727,9 +1727,9 @@ class BiBase {
         this.errorDump = true;
         /**
          * Current buffer data.
-         * @type {Buffer|Uint8Array}
+         * @type {Buffer|Uint8Array|null}
          */
-        this.data = [];
+        this.data = null;
         /**
          * When the data buffer needs to be extended while strict mode is ``false``, this will be the amount it extends.
          *
@@ -1740,10 +1740,14 @@ 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.
          */
         this.extendBufferSize = 0;
+        this.fd = null;
+        this.filePath = "";
+        this.fsMode = "";
         /**
          * The settings that used when using the .str getter / setter
          */
         this.strDefaults = { stringType: "utf-8", terminateValue: 0x0 };
+        this.maxFileSize = null;
     }
     /**
      * Settings for when using .str
@@ -1760,12 +1764,67 @@ class BiBase {
         this.strDefaults.stripNull = settings.stripNull;
         this.strDefaults.terminateValue = settings.terminateValue;
     }
-    isBufferOrUint8Array(obj) {
-        return arraybuffcheck(obj);
+    /**
+     * Enables expanding in reader (changes strict)
+     *
+     * @param {boolean} mode - Enable expanding in reader (changes strict)
+     */
+    writeMode(mode) {
+        if (mode) {
+            this.strict = false;
+            return;
+        }
+        else {
+            this.strict = true;
+            return;
+        }
+    }
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    open() {
+        return this.size;
+    }
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    updateSize() {
+        this.return;
+    }
+    /**
+     * removes data.
+     */
+    close() {
+        this.data = undefined;
+    }
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    read(start, length, consume = false) {
+        return this.lift(start, start + length, consume);
+    }
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    write(start, data, consume = false) {
+        this.insert(data, consume, start);
+        return data.length;
+    }
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    commit(consume = true) {
+        return consume ? 0 : 1;
     }
     extendArray(to_padd) {
         return extendarray(this, to_padd);
     }
+    isBufferOrUint8Array(obj) {
+        return arraybuffcheck(obj);
+    }
+    ///////////////////////////////
+    //         ENDIANNESS        //
+    ///////////////////////////////
     /**
      *
      * Change endian, defaults to little.
@@ -1819,6 +1878,9 @@ class BiBase {
     le() {
         this.endianness("little");
     }
+    ///////////////////////////////
+    //            SIZE           //
+    ///////////////////////////////
     /**
      * Size in bytes of the current buffer.
      *
@@ -1867,9 +1929,9 @@ class BiBase {
     get lenb() {
         return this.sizeB;
     }
-    //
-    //get position
-    //
+    ///////////////////////////////
+    //         POSITION          //
+    ///////////////////////////////
     /**
      * Get the current byte position.
      *
@@ -2030,9 +2092,9 @@ class BiBase {
     get row() {
         return Math.abs(Math.floor((this.offset - 1) / 16));
     }
-    //
-    //finishing
-    //
+    ///////////////////////////////
+    //        FINISHING          //
+    ///////////////////////////////
     /**
      * Returns current data.
      *
@@ -2088,9 +2150,9 @@ class BiBase {
     errorDumpOn() {
         this.errorDump = true;
     }
-    //
-    //strict mode change
-    //
+    ///////////////////////////////
+    //       STRICTMODE          //
+    ///////////////////////////////
     /**
      * Disallows extending data if position is outside of max size.
      */
@@ -2109,12 +2171,6 @@ class BiBase {
     end() {
         this.data = undefined;
     }
-    /**
-     * removes data.
-     */
-    close() {
-        this.data = undefined;
-    }
     /**
      * removes data.
      */
@@ -2127,9 +2183,9 @@ class BiBase {
     finished() {
         this.data = undefined;
     }
-    //
-    //find
-    //
+    ///////////////////////////////
+    //          FIND             //
+    ///////////////////////////////
     /**
      * Searches for byte position of string from current read position.
      *
@@ -2237,9 +2293,9 @@ class BiBase {
     findDoubleFloat(value, endian) {
         return fDoubleFloat(this, value, endian);
     }
-    //
-    // move from current position
-    //
+    ///////////////////////////////
+    //        MOVE TO            //
+    ///////////////////////////////
     /**
      * Aligns current byte position.
      *
@@ -2260,9 +2316,6 @@ class BiBase {
     alignRev(number) {
         return alignRev(this, number);
     }
-    //
-    // directly set current position
-    //
     /**
      * Offset current byte or bit position.
      *
@@ -2340,9 +2393,6 @@ class BiBase {
     warp(byte, bit) {
         return this.goto(byte, bit);
     }
-    //
-    // go to start
-    //
     /**
      * Set byte and bit position to start of data.
      */
@@ -2377,9 +2427,9 @@ class BiBase {
         this.offset = this.size;
         this.bitoffset = 0;
     }
-    //
-    //remove part of data
-    //
+    ///////////////////////////////
+    //         REMOVE            //
+    ///////////////////////////////
     /**
      * Deletes part of data from start to current byte position unless supplied, returns removed.
      *
@@ -2461,9 +2511,9 @@ class BiBase {
     overwrite(data, consume, offset) {
         return addData(this, data, consume || false, offset || this.offset, true);
     }
-    //
-    // copy out
-    //
+    ///////////////////////////////
+    //        COPY OUT           //
+    ///////////////////////////////
     /**
      * Returns part of data from current byte position to end of data unless supplied.
      *
@@ -2524,9 +2574,9 @@ class BiBase {
     wrap(length, consume) {
         return remove(this, this.offset, this.offset + (length || 0), consume || false, false);
     }
-    //
-    //insert
-    //
+    ///////////////////////////////
+    //          INSERT           //
+    ///////////////////////////////
     /**
      * Inserts data into data.
      *
@@ -2595,9 +2645,9 @@ class BiBase {
     append(data, consume) {
         return addData(this, data, consume || false, this.size, false);
     }
-    //
-    // math
-    //
+    ///////////////////////////////
+    //          MATH             //
+    ///////////////////////////////
     /**
      * XOR data.
      *
@@ -2893,9 +2943,9 @@ class BiBase {
         }
         return RSHIFT(this, lShiftKey, this.offset, this.offset + Length, consume || false);
     }
-    //
-    //bit reader
-    //
+    ///////////////////////////////
+    //        BIT READER         //
+    ///////////////////////////////
     /**
      *
      * Write bits, must have at least value and number of bits.