bireader 3.1.4 → 3.1.6

package/dist/index.esm.d.ts

@@ -33,9 +33,9 @@ type hexdumpOptions = {
      */
     startByte?: number;
     /**
-     * Supress unicode character preview for even columns.
+     * Suppress unicode character preview for even columns.
      */
-    supressUnicode?: boolean;
+    suppressUnicode?: boolean;
     /**
      * Returns the hex dump string instead of logging it.
      */
@@ -48,7 +48,7 @@ type hexdumpOptions = {
  * @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.suppressUnicode - Suppress unicode character preview for even columns.
  * @param {boolean?} options.returnString - Returns the hex dump string instead of logging it.
  */
 declare function hexdump(src: Uint8Array | Buffer, options?: hexdumpOptions): void | string;
@@ -173,6 +173,14 @@ declare class BiBase {
      * Dummy function, not needed on Non-Stream
      */
     write(start: number, data: Buffer, consume?: boolean): number;
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    renameFile(): void;
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    deleteFile(): void;
     /**
      * Dummy function, not needed on Non-Stream
      */
@@ -395,7 +403,7 @@ declare class BiBase {
     * @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.suppressUnicode - Suppress unicode character preview for even columns.
     * @param {boolean?} options.returnString - Returns the hex dump string instead of logging it.
     */
     hexdump(options?: hexdumpOptions): void | string;
@@ -1531,6 +1539,26 @@ declare class BiBaseStreamer {
      * @returns {number}
      */
     commit(consume?: boolean): number;
+    /**
+     * Renames the file you are working on.
+     *
+     * Must be full file path and file name.
+     *
+     * Keeps write / read position.
+     *
+     * Note: This is permanent and can't be undone.
+     *
+     * @param {string} newFilePath - New full file path and name.
+     */
+    renameFile(newFilePath: string): void;
+    /**
+     * Deletes the working file.
+     *
+     * Note: This is permanentand can't be undone.
+     *
+     * It doesn't send the file to the recycling bin for recovery.
+     */
+    deleteFile(): void;
     /**
      * internal extend
      *
@@ -1756,7 +1784,7 @@ declare class BiBaseStreamer {
      * @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.suppressUnicode - Suppress unicode character preview for even columns.
      * @param {boolean?} options.returnString - Returns the hex dump string instead of logging it.
      */
     hexdump(options?: hexdumpOptions): void | string;
@@ -9726,111 +9754,111 @@ interface BinaryAliasWriter extends BiBase {
     /**
      * Write 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set int64(value: number | bigint);
+    set int64(value: BigValue);
     /**
     * Write 64 bit integer.
     *
-    * @param {number|bigint} value - value as int
+    * @param {BigValue} value - value as int
     */
-    set quad(value: number | bigint);
+    set quad(value: BigValue);
     /**
      * Write 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set bigint(value: number | bigint);
+    set bigint(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set uint64(value: number | bigint);
+    set uint64(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set ubigint(value: number | bigint);
+    set ubigint(value: BigValue);
     /**
     * Write unsigned 64 bit integer.
     *
-    * @param {number|bigint} value - value as int
+    * @param {BigValue} value - value as int
     */
-    set uquad(value: number | bigint);
+    set uquad(value: BigValue);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set int64le(value: number | bigint);
+    set int64le(value: BigValue);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set bigintle(value: number | bigint);
+    set bigintle(value: BigValue);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set quadle(value: number | bigint);
+    set quadle(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set uint64le(value: number | bigint);
+    set uint64le(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set ubigintle(value: number | bigint);
+    set ubigintle(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set uquadle(value: number | bigint);
+    set uquadle(value: BigValue);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set int64be(value: number | bigint);
+    set int64be(value: BigValue);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set bigintbe(value: number | bigint);
+    set bigintbe(value: BigValue);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set quadbe(value: number | bigint);
+    set quadbe(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set uint64be(value: number | bigint);
+    set uint64be(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set ubigintbe(value: number | bigint);
+    set ubigintbe(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set uquadbe(value: number | bigint);
+    set uquadbe(value: BigValue);
     /**
      * Writes double float.
      *
@@ -12048,111 +12076,111 @@ interface BinaryAliasWriterStreamer extends BiBaseStreamer {
     /**
      * Write 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set int64(value: number | bigint);
+    set int64(value: BigValue);
     /**
     * Write 64 bit integer.
     *
-    * @param {number|bigint} value - value as int
+    * @param {BigValue} value - value as int
     */
-    set quad(value: number | bigint);
+    set quad(value: BigValue);
     /**
      * Write 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set bigint(value: number | bigint);
+    set bigint(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set uint64(value: number | bigint);
+    set uint64(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set ubigint(value: number | bigint);
+    set ubigint(value: BigValue);
     /**
     * Write unsigned 64 bit integer.
     *
-    * @param {number|bigint} value - value as int
+    * @param {BigValue} value - value as int
     */
-    set uquad(value: number | bigint);
+    set uquad(value: BigValue);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set int64le(value: number | bigint);
+    set int64le(value: BigValue);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set bigintle(value: number | bigint);
+    set bigintle(value: BigValue);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set quadle(value: number | bigint);
+    set quadle(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set uint64le(value: number | bigint);
+    set uint64le(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set ubigintle(value: number | bigint);
+    set ubigintle(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set uquadle(value: number | bigint);
+    set uquadle(value: BigValue);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set int64be(value: number | bigint);
+    set int64be(value: BigValue);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set bigintbe(value: number | bigint);
+    set bigintbe(value: BigValue);
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set quadbe(value: number | bigint);
+    set quadbe(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set uint64be(value: number | bigint);
+    set uint64be(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set ubigintbe(value: number | bigint);
+    set ubigintbe(value: BigValue);
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    set uquadbe(value: number | bigint);
+    set uquadbe(value: BigValue);
     /**
      * Writes double float.
      *

package/dist/index.esm.js

@@ -17,7 +17,7 @@ function arraybuffcheck(obj) {
  * @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.suppressUnicode - Suppress unicode character preview for even columns.
  * @param {boolean?} options.returnString - Returns the hex dump string instead of logging it.
  */
 function hexdump(src, options = {}) {
@@ -59,7 +59,7 @@ function _hexDump(data, options = {}, start, end) {
         value = value >>> 0;
         return value;
     }
-    var supressUnicode = options && options.supressUnicode || false;
+    var suppressUnicode = options && options.suppressUnicode || false;
     const rows = [];
     var header = "   0  1  2  3  4  5  6  7  8  9  A  B  C  D  E  F  ";
     var ending = "0123456789ABCDEF";
@@ -83,7 +83,7 @@ function _hexDump(data, options = {}, start, end) {
             // Convert the byte to a character and add it to the result
             result += String.fromCharCode(byte);
         }
-        else if (supressUnicode) {
+        else if (suppressUnicode) {
             result += '.';
         }
         else if (hex_check(byte, 1) == 0) {
@@ -1813,6 +1813,16 @@ class BiBase {
         this.insert(data, consume, start);
         return data.length;
     }
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    renameFile() {
+    }
+    /**
+     * Dummy function, not needed on Non-Stream
+     */
+    deleteFile() {
+    }
     /**
      * Dummy function, not needed on Non-Stream
      */
@@ -2135,7 +2145,7 @@ class BiBase {
     * @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.suppressUnicode - Suppress unicode character preview for even columns.
     * @param {boolean?} options.returnString - Returns the hex dump string instead of logging it.
     */
     hexdump(options = {}) {
@@ -10059,7 +10069,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set int64(value) {
             this.writeInt64(value);
@@ -10067,7 +10077,7 @@ function applyBinaryAliasWriter(Base) {
         /**
         * Write 64 bit integer.
         *
-        * @param {number|bigint} value - value as int
+        * @param {BigValue} value - value as int
         */
         set quad(value) {
             this.writeInt64(value);
@@ -10075,7 +10085,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set bigint(value) {
             this.writeInt64(value);
@@ -10083,7 +10093,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write unsigned 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set uint64(value) {
             this.writeInt64(value, true);
@@ -10091,7 +10101,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write unsigned 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set ubigint(value) {
             this.writeInt64(value, true);
@@ -10099,7 +10109,7 @@ function applyBinaryAliasWriter(Base) {
         /**
         * Write unsigned 64 bit integer.
         *
-        * @param {number|bigint} value - value as int
+        * @param {BigValue} value - value as int
         */
         set uquad(value) {
             this.writeInt64(value, true);
@@ -10107,7 +10117,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write signed 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set int64le(value) {
             this.writeInt64(value, false, "little");
@@ -10115,7 +10125,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write signed 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set bigintle(value) {
             this.writeInt64(value, false, "little");
@@ -10123,7 +10133,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write signed 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set quadle(value) {
             this.writeInt64(value, false, "little");
@@ -10131,7 +10141,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write unsigned 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set uint64le(value) {
             this.writeInt64(value, true, "little");
@@ -10139,7 +10149,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write unsigned 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set ubigintle(value) {
             this.writeInt64(value, true, "little");
@@ -10147,7 +10157,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write unsigned 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set uquadle(value) {
             this.writeInt64(value, true, "little");
@@ -10155,7 +10165,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write signed 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set int64be(value) {
             this.writeInt64(value, false, "big");
@@ -10163,7 +10173,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write signed 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set bigintbe(value) {
             this.writeInt64(value, false, "big");
@@ -10171,7 +10181,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write signed 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set quadbe(value) {
             this.writeInt64(value, false, "big");
@@ -10179,7 +10189,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write unsigned 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set uint64be(value) {
             this.writeInt64(value, true, "big");
@@ -10187,7 +10197,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write unsigned 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set ubigintbe(value) {
             this.writeInt64(value, true, "big");
@@ -10195,7 +10205,7 @@ function applyBinaryAliasWriter(Base) {
         /**
          * Write unsigned 64 bit integer.
          *
-         * @param {number|bigint} value - value as int
+         * @param {BigValue} value - value as int
          */
         set uquadbe(value) {
             this.writeInt64(value, true, "big");
@@ -13582,6 +13592,36 @@ class BiBaseStreamer {
         }
         return this.write(this.offset, this.data, consume);
     }
+    /**
+     * Renames the file you are working on.
+     *
+     * Must be full file path and file name.
+     *
+     * Keeps write / read position.
+     *
+     * Note: This is permanent and can't be undone.
+     *
+     * @param {string} newFilePath - New full file path and name.
+     */
+    renameFile(newFilePath) {
+        fs.closeSync(this.fd);
+        this.fd = null;
+        fs.renameSync(this.filePath, newFilePath);
+        this.filePath = newFilePath;
+        this.open();
+    }
+    /**
+     * Deletes the working file.
+     *
+     * Note: This is permanentand can't be undone.
+     *
+     * It doesn't send the file to the recycling bin for recovery.
+     */
+    deleteFile() {
+        fs.closeSync(this.fd);
+        this.fd = null;
+        fs.unlinkSync(this.filePath);
+    }
     /**
      * internal extend
      *
@@ -13921,7 +13961,7 @@ class BiBaseStreamer {
      * @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.suppressUnicode - Suppress unicode character preview for even columns.
      * @param {boolean?} options.returnString - Returns the hex dump string instead of logging it.
      */
     hexdump(options = {}) {