bireader 3.1.1 → 3.1.2

package/dist/index.cjs.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.
      */
@@ -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).

package/dist/index.cjs.js

@@ -1751,9 +1751,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.
          *
@@ -1764,10 +1764,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
@@ -1784,12 +1788,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.
@@ -1843,6 +1902,9 @@ class BiBase {
     le() {
         this.endianness("little");
     }
+    ///////////////////////////////
+    //            SIZE           //
+    ///////////////////////////////
     /**
      * Size in bytes of the current buffer.
      *
@@ -1891,9 +1953,9 @@ class BiBase {
     get lenb() {
         return this.sizeB;
     }
-    //
-    //get position
-    //
+    ///////////////////////////////
+    //         POSITION          //
+    ///////////////////////////////
     /**
      * Get the current byte position.
      *
@@ -2054,9 +2116,9 @@ class BiBase {
     get row() {
         return Math.abs(Math.floor((this.offset - 1) / 16));
     }
-    //
-    //finishing
-    //
+    ///////////////////////////////
+    //        FINISHING          //
+    ///////////////////////////////
     /**
      * Returns current data.
      *
@@ -2112,9 +2174,9 @@ class BiBase {
     errorDumpOn() {
         this.errorDump = true;
     }
-    //
-    //strict mode change
-    //
+    ///////////////////////////////
+    //       STRICTMODE          //
+    ///////////////////////////////
     /**
      * Disallows extending data if position is outside of max size.
      */
@@ -2133,12 +2195,6 @@ class BiBase {
     end() {
         this.data = undefined;
     }
-    /**
-     * removes data.
-     */
-    close() {
-        this.data = undefined;
-    }
     /**
      * removes data.
      */
@@ -2151,9 +2207,9 @@ class BiBase {
     finished() {
         this.data = undefined;
     }
-    //
-    //find
-    //
+    ///////////////////////////////
+    //          FIND             //
+    ///////////////////////////////
     /**
      * Searches for byte position of string from current read position.
      *
@@ -2261,9 +2317,9 @@ class BiBase {
     findDoubleFloat(value, endian) {
         return fDoubleFloat$1(this, value, endian);
     }
-    //
-    // move from current position
-    //
+    ///////////////////////////////
+    //        MOVE TO            //
+    ///////////////////////////////
     /**
      * Aligns current byte position.
      *
@@ -2284,9 +2340,6 @@ class BiBase {
     alignRev(number) {
         return alignRev$1(this, number);
     }
-    //
-    // directly set current position
-    //
     /**
      * Offset current byte or bit position.
      *
@@ -2364,9 +2417,6 @@ class BiBase {
     warp(byte, bit) {
         return this.goto(byte, bit);
     }
-    //
-    // go to start
-    //
     /**
      * Set byte and bit position to start of data.
      */
@@ -2401,9 +2451,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.
      *
@@ -2485,9 +2535,9 @@ class BiBase {
     overwrite(data, consume, offset) {
         return addData$1(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.
      *
@@ -2548,9 +2598,9 @@ class BiBase {
     wrap(length, consume) {
         return remove$1(this, this.offset, this.offset + (length || 0), consume || false, false);
     }
-    //
-    //insert
-    //
+    ///////////////////////////////
+    //          INSERT           //
+    ///////////////////////////////
     /**
      * Inserts data into data.
      *
@@ -2619,9 +2669,9 @@ class BiBase {
     append(data, consume) {
         return addData$1(this, data, consume || false, this.size, false);
     }
-    //
-    // math
-    //
+    ///////////////////////////////
+    //          MATH             //
+    ///////////////////////////////
     /**
      * XOR data.
      *
@@ -2917,9 +2967,9 @@ class BiBase {
         }
         return RSHIFT$1(this, lShiftKey, this.offset, this.offset + Length, consume || false);
     }
-    //
-    //bit reader
-    //
+    ///////////////////////////////
+    //        BIT READER         //
+    ///////////////////////////////
     /**
      *
      * Write bits, must have at least value and number of bits.
@@ -13335,7 +13385,7 @@ class BiBaseStreamer {
         /**
          * Current buffer chunk.
          *
-         * @type {Buffer}
+         * @type {Buffer|null}
          */
         this.data = null;
         /**
@@ -13577,28 +13627,14 @@ class BiBaseStreamer {
             }
         }
         fs.ftruncateSync(this.fd, this.size + length);
-        //if (this.maxFileSize && this.maxFileSize > length) {
-        //    // stream extend
-        //    const CHUNK_SIZE = 64 * 1024;
-        //    const buffer = Buffer.alloc(CHUNK_SIZE);
-        //    var amount = length;
-        //    var start = this.size;
-        //    while (amount) {
-        //        const toWrite = Math.min(CHUNK_SIZE, amount);
-        //        fs.writeSync(this.fd, buffer, 0, toWrite, start);
-        //        start += toWrite;
-        //        amount -= toWrite;
-        //    }
-        //}
-        //else {
-        //    const buffer = Buffer.alloc(length);
-        //    fs.writeSync(this.fd, buffer, 0, buffer.length, this.size);
-        //}
         this.updateSize();
     }
     isBufferOrUint8Array(obj) {
         return arraybuffcheck(obj);
     }
+    ///////////////////////////////
+    //         ENDIANNESS        //
+    ///////////////////////////////
     /**
      *
      * Change endian, defaults to little.
@@ -13652,6 +13688,9 @@ class BiBaseStreamer {
     le() {
         this.endianness("little");
     }
+    ///////////////////////////////
+    //            SIZE           //
+    ///////////////////////////////
     /**
      * Size in bytes of the current buffer.
      *
@@ -13700,9 +13739,9 @@ class BiBaseStreamer {
     get lenb() {
         return this.sizeB;
     }
-    //
-    //get position
-    //
+    ///////////////////////////////
+    //         POSITION          //
+    ///////////////////////////////
     /**
      * Get the current byte position.
      *
@@ -13863,9 +13902,9 @@ class BiBaseStreamer {
     get row() {
         return Math.abs(Math.floor((this.offset - 1) / 16));
     }
-    //
-    //finishing
-    //
+    ///////////////////////////////
+    //        FINISHING          //
+    ///////////////////////////////
     /**
      * Returns current data.
      *
@@ -13897,15 +13936,15 @@ class BiBaseStreamer {
         return this.data || Buffer.alloc(0);
     }
     /**
- * 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 = {}) {
         return hexDump(this, options);
     }
@@ -13921,9 +13960,9 @@ class BiBaseStreamer {
     errorDumpOn() {
         this.errorDump = true;
     }
-    //
-    //strict mode change
-    //
+    ///////////////////////////////
+    //       STRICTMODE          //
+    ///////////////////////////////
     /**
      * Disallows extending data if position is outside of max size.
      */
@@ -13954,9 +13993,9 @@ class BiBaseStreamer {
     finished() {
         this.data = null;
     }
-    //
-    //find
-    //
+    ///////////////////////////////
+    //          FIND             //
+    ///////////////////////////////
     /**
      * Searches for byte position of string from current read position.
      *
@@ -14064,9 +14103,9 @@ class BiBaseStreamer {
     findDoubleFloat(value, endian) {
         return fDoubleFloat(this, value, endian);
     }
-    //
-    // move from current position
-    //
+    ///////////////////////////////
+    //        MOVE TO            //
+    ///////////////////////////////
     /**
      * Aligns current byte position.
      *
@@ -14087,9 +14126,6 @@ class BiBaseStreamer {
     alignRev(number) {
         return alignRev(this, number);
     }
-    //
-    // directly set current position
-    //
     /**
      * Offset current byte or bit position.
      *
@@ -14167,9 +14203,6 @@ class BiBaseStreamer {
     warp(byte, bit) {
         return this.goto(byte, bit);
     }
-    //
-    // go to start
-    //
     /**
      * Set byte and bit position to start of data.
      */
@@ -14204,9 +14237,9 @@ class BiBaseStreamer {
         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.
      *
@@ -14288,9 +14321,9 @@ class BiBaseStreamer {
     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.
      *
@@ -14351,9 +14384,9 @@ class BiBaseStreamer {
     wrap(length, consume) {
         return remove(this, this.offset, this.offset + (length || 0), consume || false, false);
     }
-    //
-    //insert
-    //
+    ///////////////////////////////
+    //          INSERT           //
+    ///////////////////////////////
     /**
      * Inserts data into data.
      *
@@ -14422,9 +14455,9 @@ class BiBaseStreamer {
     append(data, consume) {
         return addData(this, data, consume || false, this.size, false);
     }
-    //
-    // math
-    //
+    ///////////////////////////////
+    //          MATH             //
+    ///////////////////////////////
     /**
      * XOR data.
      *
@@ -14720,9 +14753,9 @@ class BiBaseStreamer {
         }
         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.