@thi.ng/strings 3.7.17 → 3.7.18

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-02-25T14:07:53Z
+- **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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/strings",
-  "version": "3.7.17",
+  "version": "3.7.18",
   "description": "Various string formatting & utility functions",
   "type": "module",
   "module": "./index.js",
@@ -203,5 +203,5 @@
   "thi.ng": {
     "year": 2015
   },
-  "gitHead": "6e20f80dd9df1c8055ffa3c1e4d6f7598add0c0b\n"
+  "gitHead": "190d68e7f7524631b333cfdbf32c6a23be27c166\n"
 }

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 -