@thi.ng/markdown-table 0.3.122 → 0.3.124

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-05-08T18:24:32Z
+- **Last updated**: 2024-06-29T09:28:36Z
 - **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.
 
+### [0.3.123](https://github.com/thi-ng/umbrella/tree/@thi.ng/markdown-table@0.3.123) (2024-06-21)
+
+#### ♻️ Refactoring
+
+- enforce uniform naming convention of internal functions ([56992b2](https://github.com/thi-ng/umbrella/commit/56992b2))
+
 ### [0.3.78](https://github.com/thi-ng/umbrella/tree/@thi.ng/markdown-table@0.3.78) (2023-11-09)
 
 #### ♻️ 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 189 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -66,7 +66,7 @@ For Node.js REPL:
 const mt = await import("@thi.ng/markdown-table");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 613 bytes
+Package sizes (brotli'd, pre-treeshake): ESM: 617 bytes
 
 ## Dependencies
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/markdown-table",
-  "version": "0.3.122",
+  "version": "0.3.124",
   "description": "Markdown table formatter/generator with support for column alignments",
   "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/markdown-table#readme",
+  "homepage": "https://thi.ng/markdown-table",
   "funding": [
     {
       "type": "github",
@@ -36,18 +36,18 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.2",
-    "@thi.ng/checks": "^3.6.4",
-    "@thi.ng/compose": "^3.0.4",
-    "@thi.ng/errors": "^2.5.7",
-    "@thi.ng/strings": "^3.7.33",
-    "@thi.ng/transducers": "^9.0.5"
+    "@thi.ng/api": "^8.11.4",
+    "@thi.ng/checks": "^3.6.6",
+    "@thi.ng/compose": "^3.0.6",
+    "@thi.ng/errors": "^2.5.9",
+    "@thi.ng/strings": "^3.7.35",
+    "@thi.ng/transducers": "^9.0.7"
   },
   "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": [
     "align",
@@ -87,5 +87,5 @@
     ],
     "year": 2021
   },
-  "gitHead": "df34b4a9e650cc7323575356de207d78933bdcf3\n"
+  "gitHead": "7b950c112fba0b2e7c450765b15624c3382f1354\n"
 }

package/table.d.ts

@@ -9,10 +9,10 @@ import type { Column, Row, TableOpts } from "./api.js";
  * can also be empty. By default all columns are left-aligned.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/table.ts
  * import { table } from "@thi.ng/markdown-table";
  *
- * table(
+ * const res = table(
  *   ["ID", "Actor", "Comment"],
  *   [
  *     [1, "Alice"],
@@ -23,6 +23,7 @@ import type { Column, Row, TableOpts } from "./api.js";
  *   { bold: true, align: ["r", "c", "l"] }
  * );
  *
+ * console.log(res);
  * // | **ID** | **Actor** | **Comment** |
  * // |-------:|:---------:|:------------|
  * // |      1 |   Alice   |             |
@@ -41,10 +42,10 @@ export declare const table: (header: string[], rows: Iterable<Row>, opts?: Parti
  * values using given `keys` array.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/table-keys.ts
  * import { tableKeys } from "@thi.ng/markdown-table";
  *
- * tableKeys(
+ * const res = tableKeys(
  *   ["ID", "Actor", "Comment"],
  *   ["id", "name", (x) => x.hint],
  *   [
@@ -54,8 +55,9 @@ export declare const table: (header: string[], rows: Iterable<Row>, opts?: Parti
  *       { id: 44, name: "Dora", hint: "(recipient)" },
  *   ],
  *   { bold: true, align: ["r", "c", "l"] }
- * )
+ * );
  *
+ * console.log(res);
  * // | **ID** | **Actor** | **Comment** |
  * // |-------:|:---------:|:------------|
  * // |      1 |   Alice   |             |

package/table.js

@@ -52,7 +52,7 @@ const table = (header, rows, opts = {}) => {
   const pads = widths.map((w, i) => PADS[align[i]](w));
   const colIDs = [...range(numColumns)];
   const result = body.map(
-    (row) => colIDs.map((i) => `| ${pads[i](str(row[i]))} `).join("") + "|"
+    (row) => colIDs.map((i) => `| ${pads[i](__str(row[i]))} `).join("") + "|"
   );
   result.splice(
     1,
@@ -65,13 +65,13 @@ const tableKeys = (headers, keys, items, opts) => table(
   headers,
   map(
     juxt(
-      ...keys.map((k) => isString(k) ? (x) => str(x[k]) : k)
+      ...keys.map((k) => isString(k) ? (x) => __str(x[k]) : k)
     ),
     items
   ),
   opts
 );
-const str = (x) => x != null ? String(x) : "";
+const __str = (x) => x != null ? String(x) : "";
 export {
   table,
   tableKeys