@thi.ng/hex 2.2.1 → 2.3.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-10-03T16:07:55Z
+- **Last updated**: 2022-11-23T22:46:54Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,13 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [2.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/hex@2.3.0) (2022-11-23)
+
+#### 🚀 Features
+
+- add hexdump fns ([1b97845](https://github.com/thi-ng/umbrella/commit/1b97845))
+  - add hexdump() / hexdumpLines()
+
 ## [2.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/hex@2.2.0) (2022-09-21)
 
 #### 🚀 Features

package/README.md

@@ -55,7 +55,7 @@ node --experimental-repl-await
 > const hex = await import("@thi.ng/hex");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 405 bytes
+Package sizes (gzipped, pre-treeshake): ESM: 624 bytes
 
 ## Dependencies
 

package/index.d.ts

@@ -166,4 +166,6 @@ export declare const U64LE: (x: ArrayLike<number>, i: number) => string;
  * @param i -
  */
 export declare const uuid: (id: ArrayLike<number>, i?: number) => string;
+export declare const hexdump: (bytes: Uint8Array | Uint8ClampedArray, addr: number, len: number, width?: number, ascii?: boolean) => string;
+export declare const hexdumpLines: (bytes: Uint8Array | Uint8ClampedArray, addr: number, len: number, width?: number, ascii?: boolean) => string[];
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -169,3 +169,23 @@ export const U64LE = (x, i) => U32LE(x, i + 4) + U32LE(x, i);
 export const uuid = (id, i = 0) => 
 // prettier-ignore
 `${U32BE(id, i)}-${U16BE(id, i + 4)}-${U16BE(id, i + 6)}-${U16BE(id, i + 8)}-${U48BE(id, i + 10)}`;
+export const hexdump = (bytes, addr, len, width, ascii) => hexdumpLines(bytes, addr, len, width, ascii).join("\n");
+export const hexdumpLines = (bytes, addr, len, width = 16, ascii = true) => {
+    len = Math.min(len, bytes.length - addr);
+    let res = [];
+    while (len > 0) {
+        const row = [...bytes.subarray(addr, addr + Math.min(len, width))];
+        const pad = len < width && ascii ? new Array(width - len).fill("  ") : [];
+        res.push([
+            U32(addr),
+            ...row.map(U8),
+            ...pad,
+            row
+                .map((x) => x >= 0x20 && x < 0x80 ? String.fromCharCode(x) : ".")
+                .join(""),
+        ].join(" "));
+        addr += width;
+        len -= width;
+    }
+    return res;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/hex",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "description": "Hex string formatters for 4/8/16/24/32/48/64bit words",
   "type": "module",
   "module": "./index.js",
@@ -34,12 +34,12 @@
     "test": "testament test"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.31.1",
-    "@thi.ng/testament": "^0.3.1",
+    "@microsoft/api-extractor": "^7.33.5",
+    "@thi.ng/testament": "^0.3.5",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.17",
-    "typescript": "^4.8.3"
+    "typedoc": "^0.23.20",
+    "typescript": "^4.8.4"
   },
   "keywords": [
     "binary",
@@ -55,8 +55,8 @@
     "node": ">=12.7"
   },
   "files": [
-    "*.js",
-    "*.d.ts"
+    "./*.js",
+    "./*.d.ts"
   ],
   "exports": {
     ".": {
@@ -69,5 +69,5 @@
     ],
     "year": 2020
   },
-  "gitHead": "8600007d81a7dc92634a1d54e2c32b14ab30ba80\n"
+  "gitHead": "044ee6a3895720fc78e115032d4d831b63510929\n"
 }