@thi.ng/strings 3.2.2 → 3.3.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-11-21T17:09:28Z
+- **Last updated**: 2022-03-11T12:13:49Z
 - **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.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/strings@3.3.0) (2021-12-02)
+
+#### 🚀 Features
+
+- add currency formatters ([52b7340](https://github.com/thi-ng/umbrella/commit/52b7340))
+
 ## [3.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/strings@3.2.0) (2021-11-17)
 
 #### 🚀 Features

package/README.md

@@ -32,7 +32,7 @@ This project is part of the
 
 ## About
 
-Various (80+) string formatting, word wrapping & utility functions, some
+Various (~100) string formatting, word wrapping & utility functions, some
 higher-order, some memoized.
 
 Partially based on Clojure version of [thi.ng/strf](http://thi.ng/strf).
@@ -48,6 +48,7 @@ Partially based on Clojure version of [thi.ng/strf](http://thi.ng/strf).
 
 ### Numeric formatters
 
+- `currency` / `chf` / `eur` / `gpb` / `usd` / `yen`
 - `radix`
 - `int` / `intLocale`
 - `float` / `floatFixedWidth`
@@ -142,7 +143,7 @@ node --experimental-repl-await
 > const strings = await import("@thi.ng/strings");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 4.53 KB
+Package sizes (gzipped, pre-treeshake): ESM: 4.63 KB
 
 ## Dependencies
 
@@ -208,4 +209,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2015 - 2021 Karsten Schmidt // Apache Software License 2.0
+© 2015 - 2022 Karsten Schmidt // Apache Software License 2.0

package/ansi.d.ts

@@ -7,32 +7,32 @@
  * // 'hello world!'
  * ```
  *
- * @param x
+ * @param x -
  */
 export declare const stripAnsi: (x: string) => string;
 /**
  * Returns true iff `x` contains ANSI control sequences.
  *
- * @param x
+ * @param x -
  */
 export declare const isAnsi: (x: string) => boolean;
 /**
  * Returns true iff `x` starts w/ an ANSI control sequence.
  *
- * @param x
+ * @param x -
  */
 export declare const isAnsiStart: (x: string) => boolean;
 /**
  * Returns true iff `x` ends w/ an ANSI control sequence.
  *
- * @param x
+ * @param x -
  */
 export declare const isAnsiEnd: (x: string) => boolean;
 /**
  * Returns length of `x` excluding any ANSI control sequences (via
  * {@link stripAnsi}).
  *
- * @param x
+ * @param x -
  */
 export declare const lengthAnsi: (x: string) => number;
 //# sourceMappingURL=ansi.d.ts.map

package/ansi.js

@@ -8,31 +8,31 @@ const RE = /\x1b\[[0-9;]+m/g;
  * // 'hello world!'
  * ```
  *
- * @param x
+ * @param x -
  */
 export const stripAnsi = (x) => x.replace(RE, "");
 /**
  * Returns true iff `x` contains ANSI control sequences.
  *
- * @param x
+ * @param x -
  */
 export const isAnsi = (x) => /\x1b\[[0-9;]+m/i.test(x);
 /**
  * Returns true iff `x` starts w/ an ANSI control sequence.
  *
- * @param x
+ * @param x -
  */
 export const isAnsiStart = (x) => /^\x1b\[[0-9;]+m/i.test(x);
 /**
  * Returns true iff `x` ends w/ an ANSI control sequence.
  *
- * @param x
+ * @param x -
  */
 export const isAnsiEnd = (x) => /\x1b\[[0-9;]+m$/i.test(x);
 /**
  * Returns length of `x` excluding any ANSI control sequences (via
  * {@link stripAnsi}).
  *
- * @param x
+ * @param x -
  */
 export const lengthAnsi = (x) => stripAnsi(x).length;

package/api.d.ts

@@ -57,8 +57,8 @@ export interface IWordSplit {
      * adjusted split position, e.g. taking any control sequences into account
      * (which can't be split).
      *
-     * @param word
-     * @param pos
+     * @param word -
+     * @param pos -
      */
     split: Fn2<string, number, number>;
 }

package/case.d.ts

@@ -40,7 +40,7 @@ export declare const snake: FnS;
 /**
  * Uppercase version of {@link snake}.
  *
- * @param x
+ * @param x -
  */
 export declare const upperSnake: FnS;
 /**

package/case.js

@@ -43,7 +43,7 @@ export const snake = (x) => kebab(x, "_");
 /**
  * Uppercase version of {@link snake}.
  *
- * @param x
+ * @param x -
  */
 export const upperSnake = (x) => snake(x).toUpperCase();
 /**

package/currency.d.ts

@@ -0,0 +1,8 @@
+import type { Stringer } from "./api.js";
+export declare const currency: (sym: string, pre?: boolean | undefined, prec?: number | undefined) => Stringer<number>;
+export declare const chf: Stringer<number>;
+export declare const eur: Stringer<number>;
+export declare const gbp: Stringer<number>;
+export declare const usd: Stringer<number>;
+export declare const yen: Stringer<number>;
+//# sourceMappingURL=currency.d.ts.map

package/currency.js

@@ -0,0 +1,10 @@
+import { memoizeJ } from "@thi.ng/memoize/memoizej";
+export const currency = memoizeJ((sym, pre = true, prec = 2) => {
+    const ff = (x) => x.toFixed(prec);
+    return pre ? (x) => sym + ff(x) : (x) => ff(x) + sym;
+});
+export const chf = currency("CHF ");
+export const eur = currency("€");
+export const gbp = currency("£");
+export const usd = currency("$");
+export const yen = currency("¥");

package/escape.d.ts

@@ -10,7 +10,7 @@ export declare const ESCAPES_REV: Record<number, string>;
  * - Non-BMP chars will be escaped using `\Uxxxxxxxx`
  * - Chars outside 0x20 - 0x7e range will be escaped using `\uxxxxx`
  *
- * @param src
+ * @param src -
  */
 export declare const escape: (src: string) => string;
 /**
@@ -31,7 +31,7 @@ export declare const escape: (src: string) => string;
  * // '😎'
  * ```
  *
- * @param src
+ * @param src -
  */
 export declare const unescape: (src: string) => string;
 //# sourceMappingURL=escape.d.ts.map

package/escape.js

@@ -33,7 +33,7 @@ export const ESCAPES_REV = {
  * - Non-BMP chars will be escaped using `\Uxxxxxxxx`
  * - Chars outside 0x20 - 0x7e range will be escaped using `\uxxxxx`
  *
- * @param src
+ * @param src -
  */
 export const escape = (src) => src
     .replace(/[\0\b\t\n\v\f\r'"\\]/g, (x) => `\\${ESCAPES_REV[x.charCodeAt(0)]}`)
@@ -57,7 +57,7 @@ export const escape = (src) => src
  * // '😎'
  * ```
  *
- * @param src
+ * @param src -
  */
 export const unescape = (src) => src
     .replace(/\\u([0-9a-fA-F]{4})/g, (_, id) => String.fromCharCode(parseInt(id, 16)))

package/format.d.ts

@@ -2,20 +2,20 @@ export declare const format: (fmt: any[], ...args: any[]) => string;
 /**
  * HOF version of {@link format}.
  *
- * @param fmt
+ * @param fmt -
  */
 export declare const defFormat: (fmt: any[]) => (...args: any[]) => string;
 /**
  * Helper for {@link format} which ignores argument and always returns
  * an empty string.
  *
- * @param _
+ * @param _ -
  */
 export declare const ignore: (_: any) => string;
 /**
  * Helper for {@link format} which coerces `x` to a string.
  *
- * @param x
+ * @param x -
  */
 export declare const str: (x: any) => string;
 //# sourceMappingURL=format.d.ts.map

package/format.js

@@ -10,19 +10,19 @@ export const format = (fmt, ...args) => {
 /**
  * HOF version of {@link format}.
  *
- * @param fmt
+ * @param fmt -
  */
 export const defFormat = (fmt) => (...args) => format(fmt, ...args);
 /**
  * Helper for {@link format} which ignores argument and always returns
  * an empty string.
  *
- * @param _
+ * @param _ -
  */
 export const ignore = (_) => "";
 /**
  * Helper for {@link format} which coerces `x` to a string.
  *
- * @param x
+ * @param x -
  */
 export const str = (x) => String(x);

package/index.d.ts

@@ -2,6 +2,7 @@ export * from "./api.js";
 export * from "./ansi.js";
 export * from "./case.js";
 export * from "./center.js";
+export * from "./currency.js";
 export * from "./cursor.js";
 export * from "./entities.js";
 export * from "./escape.js";

package/index.js

@@ -2,6 +2,7 @@ export * from "./api.js";
 export * from "./ansi.js";
 export * from "./case.js";
 export * from "./center.js";
+export * from "./currency.js";
 export * from "./cursor.js";
 export * from "./entities.js";
 export * from "./escape.js";

package/initials.d.ts

@@ -15,8 +15,8 @@
  * // "LvB"
  * ```
  *
- * @param parts
- * @param mode
+ * @param parts -
+ * @param mode -
  */
 export declare const initials: (parts: string[], mode?: "u" | "l" | null) => string;
 //# sourceMappingURL=initials.d.ts.map

package/initials.js

@@ -15,8 +15,8 @@
  * // "LvB"
  * ```
  *
- * @param parts
- * @param mode
+ * @param parts -
+ * @param mode -
  */
 export const initials = (parts, mode = "u") => {
     const res = parts.map((x) => x[0]).join("");

package/interpolate.d.ts

@@ -10,8 +10,8 @@ import type { IObjectOf, NumOrString } from "@thi.ng/api";
  * // "let a: number = 42;"
  * ```
  *
- * @param src
- * @param args
+ * @param src -
+ * @param args -
  */
 export declare const interpolate: (src: string, ...args: any[]) => string;
 /**
@@ -27,8 +27,8 @@ export declare const interpolate: (src: string, ...args: any[]) => string;
  * // "let a: number = 42;"
  * ```
  *
- * @param src
- * @param keys
+ * @param src -
+ * @param keys -
  */
 export declare const interpolateKeys: (src: string, keys: IObjectOf<NumOrString>) => string;
 //# sourceMappingURL=interpolate.d.ts.map

package/interpolate.js

@@ -12,8 +12,8 @@ const TPL_K = /\{([a-z0-9_.-]+)\}/gi;
  * // "let a: number = 42;"
  * ```
  *
- * @param src
- * @param args
+ * @param src -
+ * @param args -
  */
 export const interpolate = (src, ...args) => args.length > 0
     ? src.replace(TPL, (_, id) => String(args[parseInt(id, 10)]))
@@ -31,8 +31,8 @@ export const interpolate = (src, ...args) => args.length > 0
  * // "let a: number = 42;"
  * ```
  *
- * @param src
- * @param keys
+ * @param src -
+ * @param keys -
  */
 export const interpolateKeys = (src, keys) => src.replace(TPL_K, (_, id) => keys[id] != undefined
     ? String(keys[id])

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/strings",
-  "version": "3.2.2",
+  "version": "3.3.2",
   "description": "Various string formatting & utility functions",
   "type": "module",
   "module": "./index.js",
@@ -34,18 +34,18 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.2",
-    "@thi.ng/errors": "^2.1.2",
-    "@thi.ng/hex": "^2.1.2",
-    "@thi.ng/memoize": "^3.1.2"
+    "@thi.ng/api": "^8.3.4",
+    "@thi.ng/errors": "^2.1.4",
+    "@thi.ng/hex": "^2.1.4",
+    "@thi.ng/memoize": "^3.1.4"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.18.19",
-    "@thi.ng/testament": "^0.2.2",
+    "@microsoft/api-extractor": "^7.19.4",
+    "@thi.ng/testament": "^0.2.4",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.9",
-    "typescript": "^4.5.2"
+    "typedoc": "^0.22.13",
+    "typescript": "^4.6.2"
   },
   "keywords": [
     "ansi",
@@ -97,6 +97,9 @@
     "./center": {
       "import": "./center.js"
     },
+    "./currency": {
+      "import": "./currency.js"
+    },
     "./cursor": {
       "import": "./cursor.js"
     },
@@ -197,5 +200,5 @@
   "thi.ng": {
     "year": 2015
   },
-  "gitHead": "e8a7c2a40191b391cef182c2978e5a6c85987a87\n"
+  "gitHead": "0fc692a3225c068aacafdc4cb6140cf603c67ad8\n"
 }

package/ruler.d.ts

@@ -11,10 +11,10 @@
  * // !.......!.......!.......!.......!.......
  * ```
  *
- * @param width
- * @param major
- * @param a
- * @param b
+ * @param width -
+ * @param major -
+ * @param a -
+ * @param b -
  */
 export declare const ruler: (width: number, major?: number, a?: string, b?: string) => string;
 /**
@@ -51,11 +51,11 @@ export declare const ruler: (width: number, major?: number, a?: string, b?: stri
  * // +  +  +
  * ```
  *
- * @param cols
- * @param rows
- * @param w
- * @param h
- * @param chars
+ * @param cols -
+ * @param rows -
+ * @param w -
+ * @param h -
+ * @param chars -
  */
 export declare const grid: (cols: number, rows: number, w: number, h: number, [a, b, c, d]?: string) => string;
 //# sourceMappingURL=ruler.d.ts.map

package/ruler.js

@@ -12,10 +12,10 @@ import { repeat } from "./repeat.js";
  * // !.......!.......!.......!.......!.......
  * ```
  *
- * @param width
- * @param major
- * @param a
- * @param b
+ * @param width -
+ * @param major -
+ * @param a -
+ * @param b -
  */
 export const ruler = (width, major = 5, a = "|", b = "'") => repeat(a + repeat(b, major - 1), Math.ceil(width / major)).substr(0, width);
 /**
@@ -52,11 +52,11 @@ export const ruler = (width, major = 5, a = "|", b = "'") => repeat(a + repeat(b
  * // +  +  +
  * ```
  *
- * @param cols
- * @param rows
- * @param w
- * @param h
- * @param chars
+ * @param cols -
+ * @param rows -
+ * @param w -
+ * @param h -
+ * @param chars -
  */
 export const grid = (cols, rows, w, h, [a, b, c, d] = "+-| ") => {
     const major = ruler(cols * w, w, a, b) + a + "\n";

package/slugify.d.ts

@@ -22,7 +22,7 @@ export declare const slugify: Stringer<string>;
  * // "me-myself--ëye"
  * ```
  *
- * @param str
+ * @param str -
  */
 export declare const slugifyGH: (str: string) => string;
 //# sourceMappingURL=slugify.d.ts.map

package/slugify.js

@@ -33,7 +33,7 @@ export const slugify = (str) => {
  * // "me-myself--ëye"
  * ```
  *
- * @param str
+ * @param str -
  */
 export const slugifyGH = (str) => {
     return (str

package/split.d.ts

@@ -8,9 +8,9 @@
  * This function is ~2x faster for large strings (benchmarked with 8MB & 16MB
  * inputs), with dramatically lower memory consumption.
  *
- * @param src
- * @param delim
- * @param includeDelim
+ * @param src -
+ * @param delim -
+ * @param includeDelim -
  */
 export declare function split(src: string, delim?: RegExp | string, includeDelim?: boolean): Generator<string, void, unknown>;
 //# sourceMappingURL=split.d.ts.map

package/split.js

@@ -8,9 +8,9 @@
  * This function is ~2x faster for large strings (benchmarked with 8MB & 16MB
  * inputs), with dramatically lower memory consumption.
  *
- * @param src
- * @param delim
- * @param includeDelim
+ * @param src -
+ * @param delim -
+ * @param includeDelim -
  */
 export function* split(src, delim = /\r?\n/g, includeDelim = false) {
     let i = 0;

package/stringify.d.ts

@@ -5,8 +5,8 @@ import type { Stringer } from "./api.js";
  * are simply converted using `String(x)`. If `indent` is given, it will be used
  * for `JSON.stringify(x, null, indent)`
  *
- * @param all
- * @param indent
+ * @param all -
+ * @param indent -
  */
 export declare const stringify: (all?: boolean, indent?: number | undefined) => Stringer<any>;
 //# sourceMappingURL=stringify.d.ts.map

package/stringify.js

@@ -4,8 +4,8 @@
  * are simply converted using `String(x)`. If `indent` is given, it will be used
  * for `JSON.stringify(x, null, indent)`
  *
- * @param all
- * @param indent
+ * @param all -
+ * @param indent -
  */
 export const stringify = (all = false, indent) => (x) => all || (typeof x !== "string" && typeof x !== "number")
     ? JSON.stringify(x, null, indent)

package/tabs.d.ts

@@ -15,31 +15,31 @@
  * // ^   ^   ^   ^   ^   ^
  * ```
  *
- * @param src
- * @param tabSize
+ * @param src -
+ * @param tabSize -
  */
 export declare const tabsToSpaces: (src: string, tabSize?: number) => string;
 /**
  * Takes a single line string and converts all tab characters to spaces, using
  * given `tabSize`.
  *
- * @param line
- * @param tabSize
+ * @param line -
+ * @param tabSize -
  */
 export declare const tabsToSpacesLine: (line: string, tabSize?: number) => string;
 /**
  * Multi-line version of {@link spacesToTabsLine}.
  *
- * @param src
- * @param tabSize
+ * @param src -
+ * @param tabSize -
  */
 export declare const spacesToTabs: (src: string, tabSize?: number) => string;
 /**
  * Takes a single line string and converts all tab characters to spaces, using
  * given `tabSize`. Inverse op of {@link tabsToSpacesLine}.
  *
- * @param line
- * @param tabSize
+ * @param line -
+ * @param tabSize -
  */
 export declare const spacesToTabsLine: (line: string, tabSize?: number) => string;
 //# sourceMappingURL=tabs.d.ts.map

package/tabs.js

@@ -17,8 +17,8 @@ const nextTab = (x, tabSize) => Math.floor((x + tabSize) / tabSize) * tabSize;
  * // ^   ^   ^   ^   ^   ^
  * ```
  *
- * @param src
- * @param tabSize
+ * @param src -
+ * @param tabSize -
  */
 export const tabsToSpaces = (src, tabSize = 4) => src
     .split(/\r?\n/g)
@@ -28,8 +28,8 @@ export const tabsToSpaces = (src, tabSize = 4) => src
  * Takes a single line string and converts all tab characters to spaces, using
  * given `tabSize`.
  *
- * @param line
- * @param tabSize
+ * @param line -
+ * @param tabSize -
  */
 export const tabsToSpacesLine = (line, tabSize = 4) => {
     let res = "";
@@ -46,8 +46,8 @@ export const tabsToSpacesLine = (line, tabSize = 4) => {
 /**
  * Multi-line version of {@link spacesToTabsLine}.
  *
- * @param src
- * @param tabSize
+ * @param src -
+ * @param tabSize -
  */
 export const spacesToTabs = (src, tabSize = 4) => src
     .split(/\r?\n/g)
@@ -57,8 +57,8 @@ export const spacesToTabs = (src, tabSize = 4) => src
  * Takes a single line string and converts all tab characters to spaces, using
  * given `tabSize`. Inverse op of {@link tabsToSpacesLine}.
  *
- * @param line
- * @param tabSize
+ * @param line -
+ * @param tabSize -
  */
 export const spacesToTabsLine = (line, tabSize = 4) => {
     const re = /\s{2,}/g;

package/word-wrap.d.ts

@@ -28,9 +28,9 @@ export declare const SPLIT_ANSI: IWordSplit;
  *
  * @see {@link wordWrap} for main user facing alternative.
  *
- * @param line
- * @param opts
- * @param acc
+ * @param line -
+ * @param opts -
+ * @param acc -
  *
  * @internal
  */
@@ -42,16 +42,16 @@ export declare const wordWrapLine: (line: string, opts: Partial<WordWrapOpts>, a
  *
  * @see {@link wordWrap} for main user facing alternative.
  *
- * @param lines
- * @param opts
+ * @param lines -
+ * @param opts -
  */
 export declare const wordWrapLines: (lines: string, opts: Partial<WordWrapOpts>) => Line[];
 /**
  * Same as {@link wordWrapLines}, but returns wordwrapped result as string. See
  * {@link WordWrapOpts} for options.
  *
- * @param str
- * @param opts
+ * @param str -
+ * @param opts -
  */
 export declare const wordWrap: (str: string, opts: Partial<WordWrapOpts>) => string;
 export {};

package/word-wrap.js

@@ -69,10 +69,10 @@ const append = (acc, word, wordLen, width) => {
  * {@link WordWrapOpts.min} chars available and the word is longer than that, it
  * will be placed into a new line (thus minimizing legibility issues).
  *
- * @param word
- * @param opts
- * @param offset
- * @param acc
+ * @param word -
+ * @param opts -
+ * @param offset -
+ * @param acc -
  *
  * @internal
  */
@@ -103,9 +103,9 @@ const wrapWord = (word, { width, min, hard, splitter }, offset = 0, acc = []) =>
  *
  * @see {@link wordWrap} for main user facing alternative.
  *
- * @param line
- * @param opts
- * @param acc
+ * @param line -
+ * @param opts -
+ * @param acc -
  *
  * @internal
  */
@@ -134,8 +134,8 @@ export const wordWrapLine = (line, opts, acc = []) => {
  *
  * @see {@link wordWrap} for main user facing alternative.
  *
- * @param lines
- * @param opts
+ * @param lines -
+ * @param opts -
  */
 export const wordWrapLines = (lines, opts) => {
     let acc = [];
@@ -148,7 +148,7 @@ export const wordWrapLines = (lines, opts) => {
  * Same as {@link wordWrapLines}, but returns wordwrapped result as string. See
  * {@link WordWrapOpts} for options.
  *
- * @param str
- * @param opts
+ * @param str -
+ * @param opts -
  */
 export const wordWrap = (str, opts) => wordWrapLines(str, opts).join("\n");