@thi.ng/strings 3.7.37 → 3.8.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-07-06T12:02:19Z
+- **Last updated**: 2024-07-22T13:15:57Z
 - **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.
 
+## [3.8.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/strings@3.8.0) (2024-07-19)
+
+#### 🚀 Features
+
+- add namedNumber() ([979ad33](https://github.com/thi-ng/umbrella/commit/979ad33))
+
 ### [3.7.34](https://github.com/thi-ng/umbrella/tree/@thi.ng/strings@3.7.34) (2024-06-21)
 
 #### ♻️ Refactoring

package/README.md

@@ -1,13 +1,13 @@
 <!-- This file is generated - DO NOT EDIT! -->
 <!-- Please see: https://github.com/thi-ng/umbrella/blob/develop/CONTRIBUTING.md#changes-to-readme-files -->
-# ![@thi.ng/strings](https://media.thi.ng/umbrella/banners-20230807/thing-strings.svg?41f4988c)
+# ![@thi.ng/strings](https://media.thi.ng/umbrella/banners-20230807/thing-strings.svg?cf947128)
 
 [![npm version](https://img.shields.io/npm/v/@thi.ng/strings.svg)](https://www.npmjs.com/package/@thi.ng/strings)
 ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/strings.svg)
 [![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 188 standalone projects, maintained as part
+> This is one of 198 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -151,7 +151,7 @@ For Node.js REPL:
 const str = await import("@thi.ng/strings");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 5.43 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 5.52 KB
 
 ## Dependencies
 
@@ -160,9 +160,11 @@ Package sizes (brotli'd, pre-treeshake): ESM: 5.43 KB
 - [@thi.ng/hex](https://github.com/thi-ng/umbrella/tree/develop/packages/hex)
 - [@thi.ng/memoize](https://github.com/thi-ng/umbrella/tree/develop/packages/memoize)
 
+Note: @thi.ng/api is in _most_ cases a type-only import (not used at runtime)
+
 ## Usage examples
 
-Several projects in this repo's
+Eight projects in this repo's
 [/examples](https://github.com/thi-ng/umbrella/tree/develop/examples)
 directory are using this package:
 
@@ -173,7 +175,6 @@ directory are using this package:
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/crypto-chart.png" width="240"/>        | Basic crypto-currency candle chart with multiple moving averages plots                                  | [Demo](https://demo.thi.ng/umbrella/crypto-chart/)        | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/crypto-chart)        |
 |                                                                                                                            | Basic SPA example with atom-based UI router                                                             | [Demo](https://demo.thi.ng/umbrella/login-form/)          | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/login-form)          |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/mastodon-feed.jpg" width="240"/>       | Mastodon API feed reader with support for different media types, fullscreen media modal, HTML rewriting | [Demo](https://demo.thi.ng/umbrella/mastodon-feed/)       | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/mastodon-feed)       |
-| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/procedural-text.jpg" width="240"/>     | Procedural stochastic text generation via custom DSL, parse grammar & AST transformation                | [Demo](https://demo.thi.ng/umbrella/procedural-text/)     | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/procedural-text)     |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/render-audio.png" width="240"/>        | Generative audio synth offline renderer and WAV file export                                             | [Demo](https://demo.thi.ng/umbrella/render-audio/)        | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/render-audio)        |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/rstream-spreadsheet.png" width="240"/> | rstream based spreadsheet w/ S-expression formula DSL                                                   | [Demo](https://demo.thi.ng/umbrella/rstream-spreadsheet/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/rstream-spreadsheet) |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/xml-converter.png" width="240"/>       | XML/HTML/SVG to hiccup/JS conversion                                                                    | [Demo](https://demo.thi.ng/umbrella/xml-converter/)       | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/xml-converter)       |

package/index.d.ts

@@ -14,6 +14,7 @@ export * from "./initials.js";
 export * from "./int.js";
 export * from "./interpolate.js";
 export * from "./join.js";
+export * from "./named-number.js";
 export * from "./pad-left.js";
 export * from "./pad-right.js";
 export * from "./parse.js";

package/index.js

@@ -14,6 +14,7 @@ export * from "./initials.js";
 export * from "./int.js";
 export * from "./interpolate.js";
 export * from "./join.js";
+export * from "./named-number.js";
 export * from "./pad-left.js";
 export * from "./pad-right.js";
 export * from "./parse.js";

package/named-number.d.ts

@@ -0,0 +1,32 @@
+import type { Stringer } from "./api.js";
+/**
+ * Array of the english names of digits 0-9
+ */
+export declare const NAMED_DIGITS: string[];
+/**
+ * Higher-order formatter. Takes an array of named numbers (e.g. `["zero",
+ * "one", "two"...]`) and returns a function which accepts any number and either
+ * returns the corresponding name (from the given array) or otherwise the result
+ * of {@link int}.
+ *
+ * @remarks
+ * The default names used are {@link NAMED_DIGITS}.
+ *
+ * @example
+ * ```ts tangle:../export/named-number.ts
+ * import { namedNumber } from "@thi.ng/strings";
+ *
+ * console.log(namedNumber()(9));
+ * // "nine"
+ *
+ * console.log(namedNumber()(10));
+ * // "10"
+ *
+ * console.log(namedNumber(["null", "eins", "zwei"])(2));
+ * // "zwei"
+ * ```
+ *
+ * @param names
+ */
+export declare const namedNumber: (names?: string[]) => Stringer<number>;
+//# sourceMappingURL=named-number.d.ts.map

package/named-number.js

@@ -0,0 +1,18 @@
+import { int } from "./int.js";
+const NAMED_DIGITS = [
+  "zero",
+  "one",
+  "two",
+  "three",
+  "four",
+  "five",
+  "six",
+  "seven",
+  "eight",
+  "nine"
+];
+const namedNumber = (names = NAMED_DIGITS) => (x) => x >= 0 && x < names.length ? names[x | 0] : int(x);
+export {
+  NAMED_DIGITS,
+  namedNumber
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/strings",
-  "version": "3.7.37",
+  "version": "3.8.1",
   "description": "Various string formatting & utility functions",
   "type": "module",
   "module": "./index.js",
@@ -36,10 +36,10 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.5",
-    "@thi.ng/errors": "^2.5.11",
-    "@thi.ng/hex": "^2.3.49",
-    "@thi.ng/memoize": "^3.3.7"
+    "@thi.ng/api": "^8.11.7",
+    "@thi.ng/errors": "^2.5.13",
+    "@thi.ng/hex": "^2.3.51",
+    "@thi.ng/memoize": "^3.3.9"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.47.0",
@@ -133,6 +133,9 @@
     "./join": {
       "default": "./join.js"
     },
+    "./named-number": {
+      "default": "./named-number.js"
+    },
     "./pad-left": {
       "default": "./pad-left.js"
     },
@@ -203,5 +206,5 @@
   "thi.ng": {
     "year": 2015
   },
-  "gitHead": "ba4f2cd15eeb0cae30efe222524da4fed2a57267\n"
+  "gitHead": "324d6b7dbf31558329e9fb6452e29b2f7db9c61a\n"
 }

package/uuid.d.ts

@@ -5,7 +5,7 @@
  * 16.
  *
  * @remarks
- * Use [`uuid()`](https://docs.thi.ng/umbrella/random/functions/uuid.html) to
+ * Use [`uuid()`](https://docs.thi.ng/umbrella/uuid/functions/uuid.html) to
  * also generate an UUID from scratch (rather than just format one).
  *
  * @param id -