bireader 3.1.3 → 3.1.5

package/dist/index.cjs.js

@@ -1834,6 +1834,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
      */
@@ -2271,7 +2281,7 @@ class BiBase {
      *
      * Does not change current read position.
      *
-     * @param {number|bigint} value - Number to search for.
+     * @param {BigValue} value - Number to search for.
      * @param {boolean} unsigned - If the number is unsigned (default true)
      * @param {endian} endian - endianness of value (default set endian).
      */
@@ -3449,7 +3459,7 @@ class BiBase {
     /**
      * Write 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      * @param {boolean} unsigned - if the value is unsigned
      * @param {endian} endian - ``big`` or ``little``
      */
@@ -3459,7 +3469,7 @@ class BiBase {
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      * @param {endian} endian - ``big`` or ``little``
      */
     writeUInt64(value, endian) {
@@ -3468,7 +3478,7 @@ class BiBase {
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
     writeInt64LE(value) {
         return this.writeInt64(value, false, "little");
@@ -3476,7 +3486,7 @@ class BiBase {
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
     writeUInt64LE(value) {
         return this.writeInt64(value, true, "little");
@@ -3484,7 +3494,7 @@ class BiBase {
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
     writeInt64BE(value) {
         return this.writeInt64(value, false, "big");
@@ -3492,7 +3502,7 @@ class BiBase {
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
     writeUInt64BE(value) {
         return this.writeInt64(value, true, "big");
@@ -10080,7 +10090,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);
@@ -10088,7 +10098,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);
@@ -10096,7 +10106,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);
@@ -10104,7 +10114,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);
@@ -10112,7 +10122,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);
@@ -10120,7 +10130,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);
@@ -10128,7 +10138,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");
@@ -10136,7 +10146,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");
@@ -10144,7 +10154,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");
@@ -10152,7 +10162,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");
@@ -10160,7 +10170,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");
@@ -10168,7 +10178,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");
@@ -10176,7 +10186,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");
@@ -10184,7 +10194,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");
@@ -10192,7 +10202,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");
@@ -10200,7 +10210,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");
@@ -10208,7 +10218,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");
@@ -10216,7 +10226,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");
@@ -13603,6 +13613,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
      *
@@ -14057,7 +14097,7 @@ class BiBaseStreamer {
      *
      * Does not change current read position.
      *
-     * @param {number|bigint} value - Number to search for.
+     * @param {BigValue} value - Number to search for.
      * @param {boolean} unsigned - If the number is unsigned (default true)
      * @param {endian} endian - endianness of value (default set endian).
      */
@@ -15235,7 +15275,7 @@ class BiBaseStreamer {
     /**
      * Write 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      * @param {boolean} unsigned - if the value is unsigned
      * @param {endian} endian - ``big`` or ``little``
      */
@@ -15245,7 +15285,7 @@ class BiBaseStreamer {
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      * @param {endian} endian - ``big`` or ``little``
      */
     writeUInt64(value, endian) {
@@ -15254,7 +15294,7 @@ class BiBaseStreamer {
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
     writeInt64LE(value) {
         return this.writeInt64(value, false, "little");
@@ -15262,7 +15302,7 @@ class BiBaseStreamer {
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
     writeUInt64LE(value) {
         return this.writeInt64(value, true, "little");
@@ -15270,7 +15310,7 @@ class BiBaseStreamer {
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
     writeInt64BE(value) {
         return this.writeInt64(value, false, "big");
@@ -15278,7 +15318,7 @@ class BiBaseStreamer {
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
     writeUInt64BE(value) {
         return this.writeInt64(value, true, "big");