bireader 1.0.47 → 1.0.49

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/esm/index.mjs CHANGED
@@ -199,6 +199,32 @@ function addData(_this, data, consume, offset, replace) {
199
199
  _this.bitoffset = 0;
200
200
  }
201
201
  }
202
+ /**
203
+ * Console logs provided data as hex dump
204
+ *
205
+ * @param {Uint8Array|Buffer} src - Uint8Array or Buffer
206
+ * @param {object} options
207
+ * ```javascript
208
+ * {
209
+ * length: 192, // number of bytes to log, default 192 or end of data
210
+ * startByte: 0, // byte to start dump (default 0)
211
+ * supressUnicode: false // Supress unicode character preview for even columns
212
+ * }
213
+ * ```
214
+ */
215
+ export function hexdump(src, options) {
216
+ if (!(src instanceof Uint8Array || isBuffer(src))) {
217
+ throw new Error("Write data must be Uint8Array or Buffer.");
218
+ }
219
+ const fake_reader = {
220
+ data: src,
221
+ size: src.length,
222
+ offset: options && options.startByte || 0,
223
+ errorDump: true,
224
+ extendArray: extendarray,
225
+ };
226
+ hexDump(fake_reader, options);
227
+ }
202
228
  function hexDump(_this, options) {
203
229
  var length = options && options.length;
204
230
  var startByte = options && options.startByte;
@@ -1597,7 +1623,7 @@ function wstring(_this, string, options) {
1597
1623
  /**
1598
1624
  * Binary reader, includes bitfields and strings
1599
1625
  *
1600
- * @param {Buffer|Uint8Array} data - ``Buffer`` or ``Uint8Array``. Always found in ``biwriter.data``
1626
+ * @param {Buffer|Uint8Array} data - ``Buffer`` or ``Uint8Array``. Always found in ``bireader.data``
1601
1627
  * @param {number} byteOffset - Byte offset to start reader (default 0)
1602
1628
  * @param {number} bitOffset - Bit offset 0-7 to start reader (default 0)
1603
1629
  * @param {string} endianness - Endianness ``big`` or ``little`` (default ``little``)
@@ -1613,7 +1639,7 @@ export class bireader {
1613
1639
  /**
1614
1640
  * Binary reader, includes bitfields and strings
1615
1641
  *
1616
- * @param {Buffer|Uint8Array} data - ``Buffer`` or ``Uint8Array``. Always found in ``biwriter.data``
1642
+ * @param {Buffer|Uint8Array} data - ``Buffer`` or ``Uint8Array``. Always found in ``bireader.data``
1617
1643
  * @param {number} byteOffset - Byte offset to start reader (default 0)
1618
1644
  * @param {number} bitOffset - Bit offset 0-7 to start reader (default 0)
1619
1645
  * @param {string} endianness - Endianness ``big`` or ``little`` (default ``little``)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bireader",
3
- "version": "1.0.47",
3
+ "version": "1.0.49",
4
4
  "description": "Read and write data in binary",
5
5
  "module": "lib/esm/index.mjs",
6
6
  "main": "lib/cjs/index.js",