bireader 1.0.1 → 1.0.3

package/README.md

@@ -8,7 +8,7 @@ Supported data types are:
 - [Bytes](#byte) ([u]int8, byte) 8 bit signed or unsigned value
 - [Shorts](#short) ([u]int16, word, short{le|be}) 16 bit signed or unsigned value in big or little endian order
 - [Half Floats](#half-float) (halffloat, half{le|be}) 16 bit decimal value in big or little endian order
-- [Integers](#integer) ([u]int32, int, double{le|be}) 32 bit signed or unsigned value in big or little endian order
+- [Integers](#integer) ([u]int32, long, int, double{le|be}) 32 bit signed or unsigned value in big or little endian order
 - [Floats](#float) (float{le|be}) 32 bit decimal value in big or little endian
 - [Quadwords](#quadword) ([u]int64, quad, bigint{le|be}) 64 bit signed or unsigned in big or little endian
 - [Double Floats](#double-float) (doublefloat, dfloat{le|be}) 64 bit decimal value in big or little endian
@@ -341,7 +341,7 @@ Parse value as a half float (aka half). Can be in little or big endian order (``
 
 ## Integer
 
-Parse value as a int32 (aka int or double). Can be signed or unsigned (with a ``u`` at the start) and in little or big endian order (``be`` or ``le`` at the end).
+Parse value as a int32 (aka int, long or  double). Can be signed or unsigned (with a ``u`` at the start) and in little or big endian order (``be`` or ``le`` at the end).
 
 <table>
 <thead>
@@ -363,12 +363,12 @@ Parse value as a int32 (aka int or double). Can be signed or unsigned (with a ``
   </tr>
   <tr>
     <td align="center"><b>Presets (reader)</b></td>
-    <td>[u]{int32|int|double}{be|le}(*unsigned, *endian)</td>
+    <td>[u]{int32|long|int|double}{be|le}(*unsigned, *endian)</td>
     <td>If value is unsigned, little or big endian.<br>*Note: functions without the starting letter <u>u</u> can still be called unsigned when <b>true</b> is the <i>first</i> augment, and functions without ending letters <u>be</u> or <u>le</u> can still be called the endian in the <i>second</i> augment (does not overwite set endian).</td>
   </tr>
   <tr>
     <td align="center"><b>Presets (writer)</b></td>
-    <td>[u]{int32|int|double}{be|le}(<b>value</b>, offsetBytes, *unsigned, *endian)</td>
+    <td>[u]{int32|long|int|double}{be|le}(<b>value</b>, offsetBytes, *unsigned, *endian)</td>
     <td><b>value to write</b>, byte offset from current position, if value is unsigned, little or big endian<br>*Note: functions without the starting letter <u>u</u> can still be called unsigned when <b>true</b> is the <i>third</i> augment, and functions without ending letters <u>be</u> or <u>le</u> can still be called the endian in the <i>fourth</i> augment (does not overwite set endian).</td>
   </tr>
 </tbody>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bireader",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Read and write data in binary",
   "main": "index.js",
   "directories": {

package/src/reader.js

@@ -21,6 +21,10 @@ class bireader {
         }
     }
 
+    #flip = function(unsignedValue){
+        return unsignedValue > 127 ? unsignedValue - 256 : unsignedValue;
+    }
+
     /**
     *
     * byte reader, includes bitfields and strings
@@ -2473,7 +2477,7 @@ class bireader {
     */
     readByte = this.byte = this.int8 = function(unsigned){
         this.#check_size(1)
-        const read = (this.data[this.offset])
+        const read = this.#flip(this.data[this.offset])
         this.offset += 1
         if(unsigned == true){
             return read & 0xFF
@@ -2506,9 +2510,9 @@ class bireader {
         this.#check_size(2)
         var read
         if((endian != undefined ? endian : this.endian)  == "little"){
-            read = (this.data[this.offset + 1] << 8) | this.data[this.offset];
+            read = (this.#flip(this.data[this.offset + 1]) << 8) | this.#flip(this.data[this.offset]);
         } else {
-            read = (this.data[this.offset] << 8) | this.data[this.offset + 1];
+            read = (this.#flip(this.data[this.offset]) << 8) | this.#flip(this.data[this.offset + 1]);
         }
         this.offset += 2
         if(unsigned == undefined || unsigned == false){
@@ -2521,6 +2525,17 @@ class bireader {
     /**
     * Read unsigned short
     * 
+    * @param {string} endian - ```big``` or ```little```
+    * 
+    * @returns number
+    */
+    readUInt16 = this.uint16 = this.ushort = this.uword = function(endian){
+        return this.readInt16(true, endian)
+    }
+
+    /**
+    * Read unsigned short in little endian
+    * 
     * @returns number
     */
     readUInt16LE = this.uint16le = this.ushortle = this.uwordle = function(){
@@ -2528,7 +2543,7 @@ class bireader {
     }
 
     /**
-    * Read signed short
+    * Read signed short in little endian
     * 
     * @returns number
     */
@@ -2537,7 +2552,7 @@ class bireader {
     }
 
     /**
-    * Read unsigned short
+    * Read unsigned short in big endian
     * 
     * @returns number
     */
@@ -2546,7 +2561,7 @@ class bireader {
     }
 
     /**
-    * Read signed short
+    * Read signed short in big endian
     * 
     * @returns number
     */
@@ -2628,13 +2643,13 @@ class bireader {
     * @param {string} endian - ```big``` or ```little```
     * @returns number
     */
-    readInt32 = this.int = this.double = this.int32 = function(unsigned, endian){
+    readInt32 = this.int = this.double = this.int32 = this.long  = function(unsigned, endian){
         this.#check_size(4)
         var read;
         if((endian != undefined ? endian : this.endian) == "little"){
-            read = ((this.data[this.offset + 3] << 24) | (this.data[this.offset + 2] << 16) | (this.data[this.offset + 1] << 8) | this.data[this.offset])
+            read = ((this.#flip(this.data[this.offset + 3]) << 24) | (this.#flip(this.data[this.offset + 2]) << 16) | (this.#flip(this.data[this.offset + 1]) << 8) | this.#flip(this.data[this.offset]))
         } else {
-            read = (this.data[this.offset] << 24) | (this.data[this.offset + 1] << 16) | (this.data[this.offset + 2] << 8) | this.data[this.offset + 3]
+            read = (this.#flip(this.data[this.offset]) << 24) | (this.#flip(this.data[this.offset + 1]) << 16) | (this.#flip(this.data[this.offset + 2]) << 8) | this.#flip(this.data[this.offset + 3])
         }
         this.offset += 4
         if(unsigned == undefined || unsigned == false){
@@ -2649,7 +2664,7 @@ class bireader {
     * 
     * @returns number
     */
-    readUInt = this.uint = this.udouble = this.uint32 = function(){
+    readUInt = this.uint = this.udouble = this.uint32 = this.ulong = function(){
         return this.readInt32(true)
     }
 
@@ -2658,7 +2673,7 @@ class bireader {
     * 
     * @returns number
     */
-    readInt32BE = this.intbe = this.doublebe = this.int32be = function(){
+    readInt32BE = this.intbe = this.doublebe = this.int32be = this.longbe = function(){
         return this.readInt32(false, "big")
     }
 
@@ -2667,7 +2682,7 @@ class bireader {
     * 
     * @returns number
     */
-    readUInt32BE = this.uintbe = this.udoublebe = this.uint32be = function(){
+    readUInt32BE = this.uintbe = this.udoublebe = this.uint32be = this.ulongbe = function(){
         return this.readInt32(true, "big")
     }
 
@@ -2676,7 +2691,7 @@ class bireader {
     * 
     * @returns number
     */
-    readInt32LE = this.intle = this.doublele = this.int32le = function(){
+    readInt32LE = this.intle = this.doublele = this.int32le = this.longle = function(){
         return this.readInt32(false, "little")
     }
 
@@ -2685,7 +2700,7 @@ class bireader {
     * 
     * @returns number
     */
-    readUInt32LE = this.uintle = this.udoublele = this.uint32le = function(){
+    readUInt32LE = this.uintle = this.udoublele = this.uint32le = this.ulongle = function(){
         return this.readInt32(true, "little")
     }
 
@@ -2766,7 +2781,7 @@ class bireader {
         let value = BigInt(0);
         if((endian == undefined ? this.endian : endian) == "little"){
             for (let i = 0; i < 8; i++) {
-                value |= BigInt(this.data[this.offset]) << BigInt(8 * i);
+                value |= BigInt(this.#flip(this.data[this.offset])) << BigInt(8 * i);
                 this.offset += 1
             }
             if(unsigned == undefined || unsigned == false){
@@ -2779,7 +2794,7 @@ class bireader {
             }
         } else {
             for (let i = 0; i < 8; i++) {
-                value = (value << BigInt(8)) | BigInt(this.data[this.offset]);
+                value = (value << BigInt(8)) | BigInt(this.#flip(this.data[this.offset]));
                 this.offset += 1
                 }
             if(unsigned == undefined || unsigned == false){
@@ -2966,7 +2981,15 @@ class bireader {
                 terminate = 0
             }
 
-            while (this.offset < this.data.length) {
+            var read_length = 0;
+
+            if(length != undefined){
+                read_length = length
+            } else {
+                read_length = this.data.length - this.offset
+            }
+
+            for (let i = 0; i < read_length; i++) {
                 if (stringType === 'utf-8') {
                     var read = this.readUByte();
                     if(read == terminate){

package/src/writer.js

@@ -7,7 +7,7 @@
 * @param {string} endianness - endianness ``big`` or ``little`` (default little)
 * @param {boolean} strict - strict mode: if true does not extend supplied array on outside write (default false)
 */
- class biwriter {
+class biwriter {
     endian = "little";
     offset = 0;
     bitoffset = 0;
@@ -3305,7 +3305,7 @@
     * @param {boolean} unsigned - if the value is unsigned
     * @param {string} endian - ``big`` or ``little`
     */
-    writeInt32 = this.int = this.int32 = this.double = function(value, offset, unsigned, endian) {
+    writeInt32 = this.int = this.int32 = this.double = this.long = function(value, offset, unsigned, endian) {
         this.#check_size(4,0,offset)
         if (unsigned == true) {
             if (value < 0 || value > 4294967295) {
@@ -3339,7 +3339,7 @@
     * @param {number} offset - byte offset (default last write position)
     * @param {string} endian - ``big`` or ``little`
     */
-     writeUInt32 = this.uint32 = this.uint = this.udouble= function(value, offset, endian) {
+     writeUInt32 = this.uint32 = this.uint = this.udouble = this.ulong = function(value, offset, endian) {
         return this.writeInt32(value, offset, true, endian)
     }
 
@@ -3349,7 +3349,7 @@
     * @param {number} value - value as int 
     * @param {number} offset - byte offset (default last write position)
     */
-    writeInt32LE = this.int32le = this.intle = this.doublele = function(value, offset) {
+    writeInt32LE = this.int32le = this.intle = this.doublele = this.longle = function(value, offset) {
         return this.writeInt32(value, offset, false, "little")
     }
 
@@ -3359,7 +3359,7 @@
     * @param {number} value - value as int 
     * @param {number} offset - byte offset (default last write position)
     */
-    writeUInt32LE = this.uint32le = this.uintle = this.udoublele = function(value, offset) {
+    writeUInt32LE = this.uint32le = this.uintle = this.udoublele = this.ulongle = function(value, offset) {
         return this.writeInt32(value, offset, true, "little")
     }
 
@@ -3369,7 +3369,7 @@
     * @param {number} value - value as int 
     * @param {number} offset - byte offset (default last write position)
     */
-    writeInt32BE = this.int32be = this.int32be = this.doublebe = function(value, offset) {
+    writeInt32BE = this.int32be = this.int32be = this.doublebe = this.longbe = function(value, offset) {
         return this.writeInt32(value, offset, false, "big")
     }
 
@@ -3379,7 +3379,7 @@
     * @param {number} value - value as int 
     * @param {number} offset - byte offset (default last write position)
     */
-    writeUInt32BE = this.uint32be = this.uint32be = this.udoublebe = function(value, offset) {
+    writeUInt32BE = this.uint32be = this.uint32be = this.udoublebe = this.ulongbe = function(value, offset) {
         return this.writeInt32(value, offset, true, "big")
     }