@thi.ng/strings 3.7.16 → 3.7.18

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-02-22T11:59:16Z
+- **Last updated**: 2024-02-28T14:23:30Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/ansi.d.ts

@@ -3,6 +3,8 @@
  *
  * @example
  * ```ts
+ * import { stripAnsi } from "@thi.ng/strings";
+ *
  * stripAnsi("\x1B[32mhello\x1B[0m \x1B[91mworld\x1B[0m!"");
  * // 'hello world!'
  * ```

package/case.d.ts

@@ -23,6 +23,8 @@ export declare const capitalize: FnS;
  *
  * @example
  * ```ts
+ * import { kebab } from "@thi.ng/strings";
+ *
  * kebab("FooBar23Baz");
  * // "foo-bar23-baz"
  * ```

package/center.d.ts

@@ -11,10 +11,24 @@ import type { Stringer } from "./api.js";
  *
  * @example
  * ```ts
+ * import { center, wrap } from "@thi.ng/strings";
+ *
  * center(20, "<>")(wrap(" ")("thi.ng"))
  * // "<><><> thi.ng <><><>"
  * ```
  *
+ * @example
+ * ```ts
+ * import { comp } from "@thi.ng/compose";
+ * import { center, wrap } from "@thi.ng/strings";
+ *
+ * // compose formatting function
+ * const fmt = comp(center(20,"<>"), wrap(" "));
+ *
+ * fmt("thi.ng")
+ * // "<><><> thi.ng <><><>"
+ * ```
+ *
  * @param lineWidth - target length
  * @param pad - pad character(s)
  */

package/cursor.d.ts

@@ -9,6 +9,8 @@
  *
  * @example
  * ```ts
+ * import { computeCursorPos } from "@thi.ng/strings";
+ *
  * computeCursorPos("thi.ng\numbrella", 10);
  * // [ 2, 4 ]
  *

package/escape.d.ts

@@ -27,6 +27,8 @@ export declare const escape: (src: string) => string;
  *
  * @example
  * ```ts
+ * import { unescape } from "@thi.ng/strings";
+ *
  * unescape("\\ud83d\\ude0e \\U0001f60e")
  * // '😎'
  * ```

package/hollerith.d.ts

@@ -4,6 +4,8 @@ import type { Stringer } from "./api.js";
  *
  * @example
  * ```ts
+ * import { hstr } from "@thi.ng/strings";
+ *
  * hstr("abc")  // "3Habc"
  * hstr(123.45) // "6H123.45"
  * hstr("")     // "0H"

package/join.d.ts

@@ -6,11 +6,15 @@ import type { Stringer } from "./api.js";
  *
  * @example
  * ```ts
+ * import { format, join } from "@thi.ng/strings";
+ * import { partial } from "@thi.ng/compose";
+ *
  * const slashes = join("/");
  *
  * slashes([1, 2, 3]);
  * // "1/2/3"
  *
+ * // pre-compose formatter function w/ partial arguments
  * const formatOBJFace = partial(
  *   format, ["f ", slashes, " ", slashes, " ", slashes]
  * );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/strings",
-  "version": "3.7.16",
+  "version": "3.7.18",
   "description": "Various string formatting & utility functions",
   "type": "module",
   "module": "./index.js",
@@ -35,10 +35,10 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.25",
+    "@thi.ng/api": "^8.9.26",
     "@thi.ng/errors": "^2.4.18",
     "@thi.ng/hex": "^2.3.37",
-    "@thi.ng/memoize": "^3.1.59"
+    "@thi.ng/memoize": "^3.1.60"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.40.1",
@@ -203,5 +203,5 @@
   "thi.ng": {
     "year": 2015
   },
-  "gitHead": "4513a1c703bdbf0f0867f03e547e47692e415fac\n"
+  "gitHead": "190d68e7f7524631b333cfdbf32c6a23be27c166\n"
 }

package/ruler.d.ts

@@ -4,6 +4,8 @@
  *
  * @example
  * ```ts
+ * import { ruler } from "@thi.ng/strings";
+ *
  * console.log(ruler(40))
  * // |''''|''''|''''|''''|''''|''''|''''|''''
  *
@@ -23,6 +25,8 @@ export declare const ruler: (width: number, major?: number, a?: string, b?: stri
  *
  * @example
  * ```ts
+ * import { grid } from "@thi.ng/strings";
+ *
  * console.log(grid(3, 3, 4, 2));
  * // +---+---+---+
  * // |   |   |   |

package/slugify.d.ts

@@ -5,6 +5,8 @@ import type { Stringer } from "./api.js";
  *
  * @example
  * ```ts
+ * import { slugify } from "@thi.ng/strings";
+ *
  * slugify("Me, myself (& ëye) 😀!")
  * // "me-myself-and-eye"
  * ```
@@ -18,6 +20,8 @@ export declare const slugify: Stringer<string>;
  *
  * @example
  * ```ts
+ * import { slugifyGH } from "@thi.ng/strings";
+ *
  * slugifyGH("Me, myself (& ëye) 😀!")
  * // "me-myself--ëye-"
  * ```

package/stringify.d.ts

@@ -1,9 +1,24 @@
 import type { Stringer } from "./api.js";
 /**
- * Higher order version of `JSON.stringify()` with the option to treat strings
- * and numbers differently. If `all` is `false` (default), strings and numbers
- * are simply converted using `String(x)`. If `indent` is given, it will be used
- * for `JSON.stringify(x, null, indent)`
+ * Higher order version of `JSON.stringify()` with the option to treat top-level
+ * strings and numbers differently (i.e. NOT if they're nested values!). If
+ * `all` is `false` (default), strings and numbers are simply converted using
+ * `String(x)`. If `indent` is given, it will be used for `JSON.stringify(x,
+ * null, indent)`
+ *
+ * @example
+ * ```ts
+ * import { stringify } from "@thi.ng/strings";
+ *
+ * stringify()("hello");
+ * // hello
+ *
+ * stringify(true)("hello");
+ * // "hello"
+ *
+ * stringify()({ a: "hello" })
+ * // { "a": "hello" }
+ * ```
  *
  * @param all -
  * @param indent -

package/tabs.d.ts

@@ -3,6 +3,8 @@
  *
  * @example
  * ```ts
+ * import { tabsToSpaces } from "@thi.ng/strings";
+ *
  * console.log(
  *   tabsToSpaces("0\t1\t2", 10)
  *   + "\n" +

package/trim.d.ts

@@ -5,6 +5,8 @@ import type { Stringer } from "./api.js";
  *
  * @example
  * ```ts
+ * import { trim } from "@thi.ng/strings";
+ *
  * trim()("  Hello   ")
  * // "Hello"
  *