bireader 3.1.3 → 3.1.5

package/dist/index.browser.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 type endian = "little" | "big";
+type BigValue = number | bigint;
 type BiOptions = {
     /**
      * Byte offset to start writer, default is 0
@@ -172,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
      */
@@ -479,11 +488,11 @@ declare 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).
      */
-    findInt64(value: number | bigint, unsigned?: boolean, endian?: endian): number;
+    findInt64(value: BigValue, unsigned?: boolean, endian?: endian): number;
     /**
      * Searches for half float value position from current read position.
      *
@@ -1281,42 +1290,42 @@ declare 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``
      */
-    writeInt64(value: number | bigint, unsigned?: boolean, endian?: endian): void;
+    writeInt64(value: BigValue, unsigned?: boolean, endian?: endian): void;
     /**
      * 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: number | bigint, endian?: endian): void;
+    writeUInt64(value: BigValue, endian?: endian): void;
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    writeInt64LE(value: number | bigint): void;
+    writeInt64LE(value: BigValue): void;
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    writeUInt64LE(value: number | bigint): void;
+    writeUInt64LE(value: BigValue): void;
     /**
      * Write signed 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    writeInt64BE(value: number | bigint): void;
+    writeInt64BE(value: BigValue): void;
     /**
      * Write unsigned 64 bit integer.
      *
-     * @param {number|bigint} value - value as int
+     * @param {BigValue} value - value as int
      */
-    writeUInt64BE(value: number | bigint): void;
+    writeUInt64BE(value: BigValue): void;
     /**
      * Read unsigned 64 bit integer.
      *
@@ -6027,111 +6036,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.
      *
@@ -6690,24 +6699,24 @@ declare class BiWriter extends BiWriterBase implements BinaryAliasWriter {
     set float(value: number);
     set floatle(value: number);
     set floatbe(value: number);
-    set int64(value: number);
-    set quad(value: number);
-    set bigint(value: number);
-    set uint64(value: number);
-    set ubigint(value: number);
-    set uquad(value: number);
-    set int64le(value: number);
-    set bigintle(value: number);
-    set quadle(value: number);
-    set uint64le(value: number);
-    set ubigintle(value: number);
-    set uquadle(value: number);
-    set int64be(value: number);
-    set bigintbe(value: number);
-    set quadbe(value: number);
-    set uint64be(value: number);
-    set ubigintbe(value: number);
-    set uquadbe(value: number);
+    set int64(value: BigValue);
+    set quad(value: BigValue);
+    set bigint(value: BigValue);
+    set uint64(value: BigValue);
+    set ubigint(value: BigValue);
+    set uquad(value: BigValue);
+    set int64le(value: BigValue);
+    set bigintle(value: BigValue);
+    set quadle(value: BigValue);
+    set uint64le(value: BigValue);
+    set ubigintle(value: BigValue);
+    set uquadle(value: BigValue);
+    set int64be(value: BigValue);
+    set bigintbe(value: BigValue);
+    set quadbe(value: BigValue);
+    set uint64be(value: BigValue);
+    set ubigintbe(value: BigValue);
+    set uquadbe(value: BigValue);
     set doublefloat(value: number);
     set dfloat(value: number);
     set dfloatbe(value: number);
@@ -6749,6 +6758,22 @@ declare class BiWriter extends BiWriterBase implements BinaryAliasWriter {
     wpstring4be(string: string): void;
 }
 
+/**
+ * Isn't usable in browser.
+ * @since 3.0
+ * @deprecated Use ``BiReader`` instead.
+ */
+declare class BiReaderStream {
+    constructor();
+}
+/**
+ * Isn't usable in browser.
+ * @since 3.0
+ * @deprecated Use ``BiWriter`` instead.
+ */
+declare class BiWriterStream {
+    constructor();
+}
 /**
  * Not in use anymore.
  * @since 3.0
@@ -6766,4 +6791,4 @@ declare class biwriter {
     constructor();
 }
 
-export { BiReader, BiWriter, bireader, biwriter, hexdump };
+export { BiReader, BiReaderStream, BiWriter, BiWriterStream, bireader, biwriter, hexdump };

package/dist/index.browser.js

@@ -1810,6 +1810,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
      */
@@ -2247,7 +2257,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).
      */
@@ -3425,7 +3435,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``
      */
@@ -3435,7 +3445,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) {
@@ -3444,7 +3454,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");
@@ -3452,7 +3462,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");
@@ -3460,7 +3470,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");
@@ -3468,7 +3478,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");
@@ -10056,7 +10066,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);
@@ -10064,7 +10074,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);
@@ -10072,7 +10082,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);
@@ -10080,7 +10090,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);
@@ -10088,7 +10098,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);
@@ -10096,7 +10106,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);
@@ -10104,7 +10114,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");
@@ -10112,7 +10122,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");
@@ -10120,7 +10130,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");
@@ -10128,7 +10138,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");
@@ -10136,7 +10146,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");
@@ -10144,7 +10154,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");
@@ -10152,7 +10162,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");
@@ -10160,7 +10170,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");
@@ -10168,7 +10178,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");
@@ -10176,7 +10186,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");
@@ -10184,7 +10194,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");
@@ -10192,7 +10202,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");
@@ -11582,6 +11592,26 @@ class BiWriter extends BiWriterBase {
     }
 }
 
+/**
+ * Isn't usable in browser.
+ * @since 3.0
+ * @deprecated Use ``BiReader`` instead.
+ */
+class BiReaderStream {
+    constructor() {
+        throw new Error("BiReaderStream isn't usable in browser. Use BiReader instead.");
+    }
+}
+/**
+ * Isn't usable in browser.
+ * @since 3.0
+ * @deprecated Use ``BiWriter`` instead.
+ */
+class BiWriterStream {
+    constructor() {
+        throw new Error("BiReaderStream isn't usable in browser. Use BiReader instead.");
+    }
+}
 /**
  * Not in use anymore.
  * @since 3.0
@@ -11603,5 +11633,5 @@ class biwriter {
     }
 }
 
-export { BiReader, BiWriter, bireader, biwriter, hexdump };
+export { BiReader, BiReaderStream, BiWriter, BiWriterStream, bireader, biwriter, hexdump };
 //# sourceMappingURL=index.browser.js.map