bireader 3.1.3 → 3.1.5

package/README.md

@@ -1,6 +1,6 @@
 # BiReader / BiWriter
 
-A feature rich binary reader ***and writer*** that keeps track of your position to quickly create file structures. Includes shared naming conventions, programmable inputs and advanced math for easy data conversions on low level parsing. Accepts `Uint8Array` or `Buffer`.
+A feature rich binary reader ***and writer*** that keeps track of your position to quickly create file structures. Includes shared naming conventions, programmable inputs and advanced math for easy data conversions on low level parsing. Accepts `Uint8Array`, `Buffer` or a ``filePath`` with [Streams](#bistreams).
 
 Supported data types:
 
@@ -18,7 +18,8 @@ Supported data types:
 
 ### v3
  * Added Browser, Node CommonJS and Node ESM modules.
- * Added new ``BiReaderStream`` and ``BiWriterStream`` for use in Node with large file size (4 gig+). See [documention](#bistreams) for how to use.
+ * Added new ``BiReaderStream`` and ``BiWriterStream`` (Node only) that works without loading the whole file into memory. See [documention](#bistreams) for how to use.
+ * Added ``.deleteFile()`` and ``.renameFile(filePath)``.
  * Added setter ``.strSettings`` for use with ``.str`` for easier coding.
  * Added better options for extending array buffer when writing data with ``extendBufferSize``.
  * Consolidated all options argument into single object when creating class.
@@ -27,6 +28,7 @@ Supported data types:
 
 ### v2
  * Created new ``BiReader`` and ``BiWriter`` classes with *get* and *set* functions for easier coding.
+ * Marked ``bireader`` and ``biwriter`` as deprecated. Set to be removed next update.
 
 ### v1
  * Included math functions and value searches.
@@ -36,7 +38,7 @@ Supported data types:
 
 ```npm install bireader```
 
-Provides both CommonJS and ES modules for Browser and Node.
+Provides both CommonJS and ES modules for Node and Browser.
 
 ### Example
 
@@ -743,7 +745,7 @@ Common functions for setup, movement, manipulation and math shared by both.
 
 ## BiStreams
 
-With 3.1 you can now use ``BiReaderStream`` and ``BiWriterStream`` in Node for larger files (or if you don't want or need the whole file loaded to memory all at once).
+With 3.1 you can now use ``BiReaderStream`` and ``BiWriterStream`` (Node only) designed for larger files (or if you don't want or need the whole file loaded to memory all at once).
 
 <table>
 <thead>
@@ -787,7 +789,18 @@ With 3.1 you can now use ``BiReaderStream`` and ``BiWriterStream`` in Node for l
     <td align="center"><b>True if you want to switch to writing in BiReaderStream.</td>
     <td>Note: This changes reader to write mode. Allows file to be expanded in size as well.</td>
   </tr>
-  
+  <tr>
+    <td>Name</td>
+    <td>renameFile(<b>newFilePath</b>)
+    <td align="center"><b>Full path to file to rename.</td>
+    <td>Renames the file on the file system, keeps read / write position.<br/><br/><b>Note: This is permanent.</b></td>
+  </tr>
+  <tr>
+    <td>Name</td>
+    <td>deleteFile()
+    <td align="center"><b>none</td>
+    <td>Unlinks the file from the file system.<br/><br/><b>Note: This is permanent, it doesn't send the file to the recycling bin for recovery.</b></td>
+  </tr>
 </tbody>
 </table>
 

package/dist/BiWriter.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { BiOptions, endian, stringOptions } from "./common.js";
+import { BigValue, BiOptions, endian, stringOptions } from "./common.js";
 import { BiBase } from './core/BiBase.js';
 import { BinaryAliasWriter } from "./aliases/BinaryAliasWriter.js";
 declare const BiWriterBase: typeof BiBase;
@@ -283,24 +283,24 @@ export 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);

package/dist/BiWriterStream.d.ts

@@ -1,4 +1,4 @@
-import { BiOptions, endian, stringOptions } from "./common.js";
+import { BigValue, BiOptions, endian, stringOptions } from "./common.js";
 import { BiBaseStreamer } from './core/BiBaseStream.js';
 import { BinaryAliasWriterStreamer } from "./aliases/BinaryAliasWriter.js";
 declare const BiWriterStreamer: typeof BiBaseStreamer;
@@ -286,24 +286,24 @@ export declare class BiWriterStream extends BiWriterStreamer implements BinaryAl
     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);

package/dist/aliases/BinaryAliasWriter.d.ts

@@ -1,4 +1,4 @@
-import { stringOptions, endian } from "../common.js";
+import { BigValue, stringOptions, endian } from "../common.js";
 import { BiBase } from '../core/BiBase.js';
 import { BiBaseStreamer } from '../core/BiBaseStream.js';
 export interface BinaryAliasWriter extends BiBase {
@@ -1942,111 +1942,111 @@ export 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.
      *
@@ -4264,111 +4264,111 @@ export 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/common.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 export type endian = "little" | "big";
+export type BigValue = number | bigint;
 export type BiOptions = {
     /**
      * Byte offset to start writer, default is 0

package/dist/core/BiBase.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { endian, hexdumpOptions, stringOptions } from '../common.js';
+import { BigValue, endian, hexdumpOptions, stringOptions } from '../common.js';
 export declare class BiBase {
     /**
      * Endianness of default read.
@@ -86,6 +86,14 @@ export 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
      */
@@ -393,11 +401,11 @@ export 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.
      *
@@ -1195,42 +1203,42 @@ export 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.
      *

package/dist/core/BiBaseStream.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { endian, hexdumpOptions, stringOptions } from '../common.js';
+import { BigValue, endian, hexdumpOptions, stringOptions } from '../common.js';
 /**
  * For file system in Node
  */
@@ -117,6 +117,26 @@ export 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
      *
@@ -427,11 +447,11 @@ export 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.
      *
@@ -1229,42 +1249,42 @@ export 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.
      *