bireader 3.1.4 → 3.1.6

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
 
@@ -51,7 +53,7 @@ import {BiReader, BiWriter} from 'bireader';
 function parse_webp(data){
   const br = new BiReader(data);
   br.strSettings = {length: 4};
-  br.hexdump({supressUnicode:true}); // console.log data as hex
+  br.hexdump({suppressUnicode:true}); // console.log data as hex
 
   //         0  1  2  3  4  5  6  7  8  9  A  B  C  D  E  F  0123456789ABCDEF
   // 00000  52 49 46 46 98 3a 00 00 57 45 42 50 56 50 38 58  RIFF.:..WEBPVP8X
@@ -426,8 +428,8 @@ Common functions for setup, movement, manipulation and math shared by both.
   </tr>
   <tr>
     <td>Name</td>
-    <td>hexdump({length, startByte, supressUnicode})</td>
-    <td align="center">Length of dump in bytes (default 192), byte position to start the dump (default current byte position), supress unicode character preview for cleaner columns (default false)</td>
+    <td>hexdump({length, startByte, suppressUnicode})</td>
+    <td align="center">Length of dump in bytes (default 192), byte position to start the dump (default current byte position), Suppress unicode character preview for cleaner columns (default false)</td>
     <td >Console logs data. Will trigger on error unless turned off (see below)</td>
   </tr>
   <tr>
@@ -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/index.browser.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;
@@ -6028,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.
      *
@@ -6750,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
@@ -6767,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

@@ -14,7 +14,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 = {}) {
@@ -56,7 +56,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";
@@ -80,7 +80,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) {
@@ -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
      */
@@ -2132,7 +2142,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 = {}) {
@@ -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