@thi.ng/compare 2.2.25 → 2.2.26

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-03-09T09:18:17Z
+- **Last updated**: 2024-03-13T14:04:31Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/keys.d.ts

@@ -6,15 +6,15 @@ import type { Comparator, Fn, Keys, Val1 } from "@thi.ng/api";
  * @param key -
  * @param cmp -
  */
-export declare function compareByKey<T, A extends Keys<T>>(a: A, cmp?: Comparator<Val1<T, A>>): Comparator<T>;
+export declare function compareByKey<T, K extends Keys<T>>(key: K, cmp?: Comparator<Val1<T, K>>): Comparator<T>;
 export declare function compareByKey<T, A>(a: Fn<T, A>, cmp?: Comparator<A>): Comparator<T>;
 /**
  * HOF comparator. Returns new comparator to sort objects by given keys
  * `a` (major), `b` (minor) and with optional comparators (default for
  * each: {@link compare}).
  *
- * @param a -
- * @param b -
+ * @param major -
+ * @param minor -
  * @param cmpA -
  * @param cmpB -
  */
@@ -23,14 +23,14 @@ export declare function compareByKeys2<T, A, B>(major: Fn<T, A>, minor: Fn<T, B>
 /**
  * Same as {@link compareByKeys2}, but for 3 sort keys / comparators.
  *
- * @param a -
- * @param b -
- * @param c -
+ * @param major -
+ * @param minor -
+ * @param patch -
  * @param cmpA -
  * @param cmpB -
  * @param cmpC -
  */
-export declare function compareByKeys3<T, A extends Keys<T>, B extends Keys<T>, C extends Keys<T>>(major: A, minor: B, patch: B, cmpA?: Comparator<Val1<T, A>>, cmpB?: Comparator<Val1<T, B>>, cmpC?: Comparator<Val1<T, C>>): Comparator<T>;
+export declare function compareByKeys3<T, A extends Keys<T>, B extends Keys<T>, C extends Keys<T>>(major: A, minor: B, patch: C, cmpA?: Comparator<Val1<T, A>>, cmpB?: Comparator<Val1<T, B>>, cmpC?: Comparator<Val1<T, C>>): Comparator<T>;
 export declare function compareByKeys3<T, A, B, C>(major: Fn<T, A>, minor: Fn<T, B>, patch: Fn<T, C>, cmpA?: Comparator<A>, cmpB?: Comparator<B>, cmpC?: Comparator<C>): Comparator<T>;
 /**
  * Same as {@link compareByKeys2}, but for 4 sort keys / comparators.

package/keys.js

@@ -1,8 +1,8 @@
 import { compare } from "./compare.js";
 const getKey = (k) => typeof k === "function" ? k : (x) => x[k];
-function compareByKey(a, cmp = compare) {
-  const k = getKey(a);
-  return (x, y) => cmp(k(x), k(y));
+function compareByKey(key, cmp = compare) {
+  const kfn = getKey(key);
+  return (x, y) => cmp(kfn(x), kfn(y));
 }
 function compareByKeys2(a, b, cmpA = compare, cmpB = compare) {
   const ka = getKey(a);

package/ops.d.ts

@@ -11,7 +11,7 @@ export declare const OPERATORS: Record<Operator, Predicate2<string> | Predicate2
  * See {@link numericOp} for related functionality.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/string-op.ts
  * import { stringOp } from "@thi.ng/compare";
  *
  * const equalsABC = stringOp("=", "abc");
@@ -44,7 +44,7 @@ export declare const stringOp: (op: Operator | Predicate2<string>, x: string) =>
  * false.
  *
  * @example
- * ```ts
+ * ```ts tangle:../export/numeric-op.ts
  * import { numericOp } from "@thi.ng/compare";
  *
  * const lessThan42 = numericOp("<", 42);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/compare",
-  "version": "2.2.25",
+  "version": "2.2.26",
   "description": "Comparators with support for types implementing the @thi.ng/api/ICompare interface",
   "type": "module",
   "module": "./index.js",
@@ -36,14 +36,14 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.29"
+    "@thi.ng/api": "^8.9.30"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.40.1",
-    "esbuild": "^0.20.0",
+    "@microsoft/api-extractor": "^7.42.3",
+    "esbuild": "^0.20.1",
     "rimraf": "^5.0.5",
-    "typedoc": "^0.25.7",
-    "typescript": "^5.3.3"
+    "typedoc": "^0.25.12",
+    "typescript": "^5.4.2"
   },
   "keywords": [
     "comparator",
@@ -80,5 +80,5 @@
       "default": "./reverse.js"
     }
   },
-  "gitHead": "69100942474942f7446ac645d59d91e7dfc352f9\n"
+  "gitHead": "7f3fcbd6c0462b0ce45afa141fe163d1f297fd51\n"
 }