@thi.ng/compare 2.4.40 → 2.5.2

package/README.md

@@ -40,6 +40,7 @@ interface.
 
 ### Additional comparators
 
+- [`composeComparators()`](https://docs.thi.ng/umbrella/compare/functions/composeComparators.html)
 - [`compareByKey()`](https://docs.thi.ng/umbrella/compare/functions/compareByKey.html)
 - [`compareByKeys2()`](https://docs.thi.ng/umbrella/compare/functions/compareByKeys2.html)
 - [`compareByKeys3()`](https://docs.thi.ng/umbrella/compare/functions/compareByKeys3.html)
@@ -94,7 +95,7 @@ For Node.js REPL:
 const cmp = await import("@thi.ng/compare");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 804 bytes
+Package sizes (brotli'd, pre-treeshake): ESM: 870 bytes
 
 ## Dependencies
 

package/compose.d.ts

@@ -0,0 +1,10 @@
+import type { Comparator } from "@thi.ng/api";
+/**
+ * Returns a comparator which applies given comparators in given order for as
+ * long as the current comparator returns 0. In other words, returns the result
+ * of the first comparator with non-zero result, or if none does, returns zero.
+ *
+ * @param cmp
+ */
+export declare const composeComparators: <T = any>(cmp: Comparator<T>, ...xs: Comparator<T>[]) => Comparator<T>;
+//# sourceMappingURL=compose.d.ts.map

package/compose.js

@@ -0,0 +1,17 @@
+const composeComparators = (cmp, ...xs) => {
+  if (xs.length) {
+    const fns = [cmp, ...xs];
+    const n = fns.length;
+    return (a, b) => {
+      for (let i = 0; i < n; i++) {
+        const res = fns[i](a, b);
+        if (res !== 0) return res;
+      }
+      return 0;
+    };
+  }
+  return cmp;
+};
+export {
+  composeComparators
+};

package/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./compare.js";
+export * from "./compose.js";
 export * from "./keys.js";
 export * from "./length.js";
 export * from "./numeric.js";

package/index.js

@@ -1,4 +1,5 @@
 export * from "./compare.js";
+export * from "./compose.js";
 export * from "./keys.js";
 export * from "./length.js";
 export * from "./numeric.js";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@thi.ng/compare",
-	"version": "2.4.40",
+	"version": "2.5.2",
 	"description": "Comparators with support for types implementing the @thi.ng/api/ICompare interface",
 	"type": "module",
 	"module": "./index.js",
@@ -40,7 +40,7 @@
 		"tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
 	},
 	"dependencies": {
-		"@thi.ng/api": "^8.12.14"
+		"@thi.ng/api": "^8.12.16"
 	},
 	"devDependencies": {
 		"esbuild": "^0.27.2",
@@ -69,6 +69,9 @@
 		"./compare": {
 			"default": "./compare.js"
 		},
+		"./compose": {
+			"default": "./compose.js"
+		},
 		"./keys": {
 			"default": "./keys.js"
 		},
@@ -91,5 +94,5 @@
 	"thi.ng": {
 		"alias": "cmp"
 	},
-	"gitHead": "4bd1b9d8ae52ba32b90a1b9a55d329c708ca7865\n"
+	"gitHead": "411adbeeb5c03da1cf0c86e567c80942a6b875e7\n"
 }