bireader 3.1.3 → 3.1.5

package/dist/index.cjs.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.
      *
@@ -1530,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
      *
@@ -1840,11 +1869,11 @@ declare 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).
      */
-    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.
      *
@@ -2642,42 +2671,42 @@ declare 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``
      */
-    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.
      *
@@ -9725,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.
      *
@@ -12047,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.
      *
@@ -12710,24 +12739,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);
@@ -13391,24 +13420,24 @@ declare class BiWriterStream extends BiWriterStreamer implements BinaryAliasWrit
     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);