@thi.ng/transducers-binary 2.1.120 → 2.1.121

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-05-08T18:24:32Z
+- **Last updated**: 2024-06-21T19:34:38Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ 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.1.121](https://github.com/thi-ng/umbrella/tree/@thi.ng/transducers-binary@2.1.121) (2024-06-21)
+
+#### ♻️ Refactoring
+
+- enforce uniform naming convention of internal functions ([56992b2](https://github.com/thi-ng/umbrella/commit/56992b2))
+
 ### [2.1.115](https://github.com/thi-ng/umbrella/tree/@thi.ng/transducers-binary@2.1.115) (2024-04-08)
 
 #### ♻️ Refactoring

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 192 standalone projects, maintained as part
+> This is one of 193 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >

package/bits.d.ts

@@ -4,13 +4,18 @@ import type { Transducer } from "@thi.ng/transducers";
  * word size (default 8) and order (MSB first or LSB first). Only the
  * lowest `wordSize` bits of each value are used (max 32).
  *
- * ```ts
+ * ```ts tangle:../export/bits.ts
  * import { bits } from "@thi.ng/transducers-binary";
  * import { comp, iterator, partition } from "@thi.ng/transducers";
  *
- * [...bits(8, [0xf0, 0xaa])]
+ * console.log(
+ *   [...bits(8, [0xf0, 0xaa])]
+ * );
  * // [ 1, 1, 1, 1, 0, 0, 0, 0, 1, 0, 1, 0, 1, 0, 1, 0 ]
- * [...iterator(comp(bits(8), partition(4)), [0xf0, 0xaa])]
+ *
+ * console.log(
+ *   [...iterator(comp(bits(8), partition(4)), [0xf0, 0xaa])]
+ * );
  * // [ [ 1, 1, 1, 1 ], [ 0, 0, 0, 0 ], [ 1, 0, 1, 0 ], [ 1, 0, 1, 0 ] ]
  * ```
  *

package/bytes.d.ts

@@ -27,18 +27,20 @@ export declare const str: (x: string) => BinStructItem;
  * for streaming purposes).
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/as-bytes.ts
  * import {
  *   asBytes, f32, i16, str, u32,
  *   hexDumpString
  * } from "@thi.ng/transducers-binary";
  *
- * hexDumpString({}, asBytes([
+ * const bytes = asBytes([
  *   str("hello!"),
  *   u32(0xdecafbad),
  *   i16(-1),
  *   f32(Math.PI)
- * ]))
+ * ]);
+ *
+ * console.log(hexDumpString({}, bytes));
  * // 00000000 | 68 65 6c 6c 6f 21 de ca fb ad ff ff 40 49 0f db | hello!......@I..
  * ```
  */

package/hex-dump.d.ts

@@ -12,15 +12,19 @@ import type { HexDumpOpts } from "./api.js";
  * [thi.ng/hex](https://docs.thi.ng/umbrella/hex/functions/hexdump.html)
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/hex-dump.ts
  * import { hexDump } from "@thi.ng/transducers-binary";
  *
- * src = [65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 33, 48, 49, 50, 51, 126, 122, 121, 120]
+ * const src = [
+ *   65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 33, 48, 49, 50, 51, 126, 122, 121, 120
+ * ];
  *
- * [...hexDump({ cols: 8, address: 0x400 }, src)]
- * // [ '00000400 | 41 42 43 44 45 46 47 48 | ABCDEFGH',
- * //   '00000408 | 49 4a 21 30 31 32 33 7e | IJ!0123~',
- * //   '00000410 | 7a 79 78 00 00 00 00 00 | zyx.....' ]
+ * console.log(
+ *   [...hexDump({ cols: 8, address: 0x400 }, src)].join("\n")
+ * );
+ * // 00000400 | 41 42 43 44 45 46 47 48 | ABCDEFGH
+ * // 00000408 | 49 4a 21 30 31 32 33 7e | IJ!0123~
+ * // 00000410 | 7a 79 78 00 00 00 00 00 | zyx.....
  * ```
  *
  * @param opts -

package/hex-dump.js

@@ -11,7 +11,7 @@ function hexDump(...args) {
   if (iter) {
     return iter;
   }
-  const { cols = 16, address = 0 } = args[0];
+  const { cols = 16, address = 0 } = args[0] || {};
   return comp(
     padLast(cols, 0),
     map(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/transducers-binary",
-  "version": "2.1.120",
+  "version": "2.1.121",
   "description": "Binary data related transducers & reducers",
   "type": "module",
   "module": "./index.js",
@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/thi-ng/umbrella.git"
   },
-  "homepage": "https://github.com/thi-ng/umbrella/tree/develop/packages/transducers-binary#readme",
+  "homepage": "https://thi.ng/transducers-binary",
   "funding": [
     {
       "type": "github",
@@ -36,19 +36,19 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/binary": "^3.4.25",
-    "@thi.ng/compose": "^3.0.4",
-    "@thi.ng/errors": "^2.5.7",
-    "@thi.ng/hex": "^2.3.46",
-    "@thi.ng/random": "^3.8.0",
-    "@thi.ng/strings": "^3.7.33",
-    "@thi.ng/transducers": "^9.0.5"
+    "@thi.ng/binary": "^3.4.26",
+    "@thi.ng/compose": "^3.0.5",
+    "@thi.ng/errors": "^2.5.8",
+    "@thi.ng/hex": "^2.3.47",
+    "@thi.ng/random": "^3.8.1",
+    "@thi.ng/strings": "^3.7.34",
+    "@thi.ng/transducers": "^9.0.6"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.43.2",
-    "esbuild": "^0.21.1",
+    "@microsoft/api-extractor": "^7.47.0",
+    "esbuild": "^0.21.5",
     "typedoc": "^0.25.13",
-    "typescript": "^5.4.5"
+    "typescript": "^5.5.2"
   },
   "keywords": [
     "array",
@@ -114,5 +114,5 @@
     ],
     "year": 2018
   },
-  "gitHead": "df34b4a9e650cc7323575356de207d78933bdcf3\n"
+  "gitHead": "154c95cf9d6bab32174498ec3b5b5d87e42be7f9\n"
 }

package/partition-bits.js

@@ -4,10 +4,10 @@ function partitionBits(...args) {
   return __iter(partitionBits, args, iterator) || ((rfn) => {
     const destSize = args[0];
     const srcSize = args[1] || 8;
-    return destSize < srcSize ? small(rfn, destSize, srcSize) : destSize > srcSize ? large(rfn, destSize, srcSize) : rfn;
+    return destSize < srcSize ? __small(rfn, destSize, srcSize) : destSize > srcSize ? __large(rfn, destSize, srcSize) : rfn;
   });
 }
-const small = ([init, complete, reduce], n, wordSize) => {
+const __small = ([init, complete, reduce], n, wordSize) => {
   const maxb = wordSize - n;
   const m1 = (1 << wordSize) - 1;
   const m2 = (1 << n) - 1;
@@ -31,7 +31,7 @@ const small = ([init, complete, reduce], n, wordSize) => {
     }
   ];
 };
-const large = ([init, complete, reduce], n, wordSize) => {
+const __large = ([init, complete, reduce], n, wordSize) => {
   const m1 = (1 << wordSize) - 1;
   let r = 0;
   let y = 0;

package/utf8.d.ts

@@ -11,15 +11,17 @@ export declare function utf8Decode(src: Iterable<number>): string;
  * Also see {@link utf8Decode} for reverse transformation.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/utf8-encode.ts
  * import { hexDump, utf8Encode } from "@thi.ng/transducers-binary";
  * import { comp, str, transduce } from "@thi.ng/transducers";
  *
- * transduce(
- *   comp(utf8Encode(), hexDump()),
+ * const res = transduce(
+ *   comp(utf8Encode(), hexDump({ cols: 8 })),
  *   str("\n"),
  *   "¡Hola niña! 😀"
- * )
+ * );
+ *
+ * console.log(res);
  * // 00000000 | c2 a1 48 6f 6c 61 20 6e | ..Hola n
  * // 00000008 | 69 c3 b1 61 21 20 f0 9f | i..a! ..
  * // 00000010 | 98 80 00 00 00 00 00 00 | ........