@thi.ng/arrays 2.10.13 → 2.10.15

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2025-01-23T13:39:11Z
+- **Last updated**: 2025-02-13T16:03:11Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

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 200 standalone projects, maintained as part
+> This is one of 201 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >

package/binary-search.d.ts

@@ -11,8 +11,8 @@ import type { Comparator, Fn, FnN, FnN2 } from "@thi.ng/api";
  * and each array item (default: identity).
  *
  * The optional `cmp` comparator (default:
- * [`compare()`](https://docs.thi.ng/umbrella/compare/functions/compare.html))
- * is then used to identify the index of `x`. The sort order of `buf` MUST be
+ * [`compare`](https://docs.thi.ng/umbrella/compare/functions/compare.html)) is
+ * then used to identify the index of `x`. The sort order of `buf` MUST be
  * compatible with that of `cmp`.
  *
  * @example
@@ -36,7 +36,7 @@ export declare const binarySearch: <A, B>(buf: ArrayLike<A>, x: A, key?: Fn<A, B
 /**
  * Similar to {@link binarySearch}, but optimized for numeric arrays and
  * supporting custom comparators (default:
- * [`compareNumAsc()`](https://docs.thi.ng/umbrella/compare/functions/compareNumAsc.html)).
+ * [`compareNumAsc`](https://docs.thi.ng/umbrella/compare/functions/compareNumAsc.html)).
  *
  * @param buf - array
  * @param x - search value

package/bisect.d.ts

@@ -1,7 +1,7 @@
 import type { Predicate, TypedArray } from "@thi.ng/api";
 /**
  * Splits array at given index (default: floor(src.length/2)) and returns tuple
- * of [lhs, rhs].
+ * of `[lhs, rhs]`.
  *
  * @param src -
  * @param index -

package/blit.d.ts

@@ -6,7 +6,7 @@ import type { Fn3, Maybe, TypedArray } from "@thi.ng/api";
  * @remarks
  * Where `src` values are the same as `mask`, the corresponding `dest` values
  * will be left unchanged. Performs region clipping, i.e. `dx` can be outside
- * the [0..dest.length) interval.
+ * the `[0,dest.length)` interval.
  *
  * @example
  * ```ts tangle:../export/blit1d.ts

package/ends-with.d.ts

@@ -6,7 +6,7 @@
  * be true.
  *
  * By default, uses
- * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) for
+ * [`equiv`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) for
  * equality checking.
  *
  * {@link startsWith}

package/fill-range.d.ts

@@ -1,11 +1,11 @@
 import type { NumericArray } from "@thi.ng/api";
 /**
- * Fills given array with values in [start .. end) interval from `index`
- * and with optional `step` size.
+ * Fills given array with values in `[start,end)` interval from `index` and with
+ * optional `step` size.
  *
  * @remarks
- * `start` and `end` default to 0 and array length, `step` defaults to 1
- * or -1 (depending on range). Returns array.
+ * `start` and `end` default to 0 and array length, `step` defaults to 1 or -1
+ * (depending on range). Returns array.
  *
  * @example
  * ```ts tangle:../export/fill-range.ts

package/find.d.ts

@@ -1,7 +1,8 @@
 import type { Predicate2 } from "@thi.ng/api";
 /**
- * Similar to `Array.find()`, but uses [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) as
- * default predicate.
+ * Similar to `Array.find()`, but uses
+ * [`equiv`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) as default
+ * predicate.
  *
  * @param buf - array
  * @param x - search value
@@ -10,8 +11,8 @@ import type { Predicate2 } from "@thi.ng/api";
 export declare const find: <T>(buf: ArrayLike<T>, x: T, equiv?: Predicate2<T>) => T | undefined;
 /**
  * Similar to `Array.findIndex()`, but uses
- * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) as
- * default predicate.
+ * [`equiv`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) as default
+ * predicate.
  *
  * @param buf - array
  * @param x - search value

package/floyd-rivest.d.ts

@@ -22,7 +22,7 @@ import type { Comparator, TypedArray } from "@thi.ng/api";
  * ```
  *
  * Based on pseudo-code from:
- * - https://en.wikipedia.org/wiki/Floyd%E2%80%93Rivest_algorithm
+ * https://en.wikipedia.org/wiki/Floyd%E2%80%93Rivest_algorithm
  *
  * @param buf
  * @param k

package/fuzzy-match.d.ts

@@ -6,13 +6,13 @@ import type { Predicate2 } from "@thi.ng/api";
  * @remarks
  * The optional `equiv` predicate can be used to customize item equality
  * checking. Uses
- * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) by
+ * [`equiv`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) by
  * default.
  *
  * Adapted and generalized from: https://github.com/bevacqua/fufuzzyzzysearch
  * (MIT licensed)
  *
- * [`filterFuzzy()`](https://docs.thi.ng/umbrella/transducers/functions/filterFuzzy.html)
+ * [`filterFuzzy`](https://docs.thi.ng/umbrella/transducers/functions/filterFuzzy.html)
  *
  * @param domain - array
  * @param query - search value

package/insert.d.ts

@@ -4,7 +4,7 @@
  *
  * @remarks
  * The function will have no effect iff `i<0` or `i>=k` or `k<1`. If
- * `buf.length` is larger than `k`, only the index range [i..k) will be
+ * `buf.length` is larger than `k`, only the index range `[i,k)` will be
  * modified.
  *
  * In benchmarking with 4, 8, 16, 32, 64 element arrays, this function is

package/is-sorted.d.ts

@@ -2,8 +2,8 @@ import type { Comparator } from "@thi.ng/api";
 /**
  * Returns true if the given array and its elements in the selected index range
  * (entire array, by default) are in the order defined by the given comparator
- * ([`compare()`](https://docs.thi.ng/umbrella/compare/functions/compare.html)
- * by default).
+ * ([`compare`](https://docs.thi.ng/umbrella/compare/functions/compare.html) by
+ * default).
  *
  * @remarks
  * Always returns true, if effective index range (or array length) has less than

package/levenshtein.d.ts

@@ -8,6 +8,7 @@ import type { Predicate2 } from "@thi.ng/api";
  * @remarks
  *
  * Based on:
+ *
  * - https://en.wikipedia.org/wiki/Levenshtein_distance
  * - https://en.wikipedia.org/wiki/Wagner%E2%80%93Fischer_algorithm
  * - https://github.com/gustf/js-levenshtein/blob/develop/index.js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/arrays",
-  "version": "2.10.13",
+  "version": "2.10.15",
   "description": "Array / Arraylike utilities",
   "type": "module",
   "module": "./index.js",
@@ -33,23 +33,22 @@
     "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
     "clean": "bun ../../tools/src/clean-package.ts",
     "doc": "typedoc --options ../../typedoc.json --out doc src/index.ts",
-    "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
     "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
     "pub": "yarn npm publish --access public",
     "test": "bun test",
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.18",
-    "@thi.ng/checks": "^3.6.21",
-    "@thi.ng/compare": "^2.4.10",
-    "@thi.ng/equiv": "^2.1.74",
-    "@thi.ng/errors": "^2.5.24",
-    "@thi.ng/random": "^4.1.9"
+    "@thi.ng/api": "^8.11.20",
+    "@thi.ng/checks": "^3.6.23",
+    "@thi.ng/compare": "^2.4.12",
+    "@thi.ng/equiv": "^2.1.76",
+    "@thi.ng/errors": "^2.5.26",
+    "@thi.ng/random": "^4.1.11"
   },
   "devDependencies": {
-    "esbuild": "^0.24.2",
-    "typedoc": "^0.27.6",
+    "esbuild": "^0.25.0",
+    "typedoc": "^0.27.7",
     "typescript": "^5.7.3"
   },
   "keywords": [
@@ -169,7 +168,8 @@
     }
   },
   "thi.ng": {
+    "tag": "array",
     "year": 2018
   },
-  "gitHead": "b92b48abda9941d608be8a2e1c83447e679a6f79\n"
+  "gitHead": "9a0b33253fef092aaf301decf6ecd54317874d4c\n"
 }

package/quicksort.d.ts

@@ -9,7 +9,7 @@ import type { Comparator, Fn3, TypedArray } from "@thi.ng/api";
  * indices (both inclusive).
  *
  * Uses Hoare partitioning scheme.
- * [`compare()`](https://docs.thi.ng/umbrella/compare/functions/compare.html) is
+ * [`compare`](https://docs.thi.ng/umbrella/compare/functions/compare.html) is
  * used as default comparator and {@link swap} from this package as default swap
  * function. Also see {@link multiSwap}.
  *

package/starts-with.d.ts

@@ -6,7 +6,7 @@
  * be true.
  *
  * By default, uses
- * [`equiv()`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) for
+ * [`equiv`](https://docs.thi.ng/umbrella/equiv/functions/equiv.html) for
  * equality checking.
  *
  * {@link endsWith}