@ezez/utils 4.3.0 → 4.4.0

package/src/sortByMultiple.spec.ts

@@ -0,0 +1,87 @@
+import { sortByMultiple } from "./sortByMultiple.js";
+
+describe("sortByMultiple", () => {
+    const items = [
+        { height: 480, bitrate: 300 },
+        { height: 720, bitrate: 100 },
+        { height: 720, bitrate: 200 },
+        { height: 720, bitrate: 50 },
+    ];
+
+    it("must sort asc", () => {
+        items.sort(sortByMultiple(["height", "bitrate"])).must.eql([
+            { height: 480, bitrate: 300 },
+            { height: 720, bitrate: 50 },
+            { height: 720, bitrate: 100 },
+            { height: 720, bitrate: 200 },
+        ]);
+    });
+
+    it("must sort desc", () => {
+        items.sort(sortByMultiple(["height", "bitrate"], false)).must.eql([
+            { height: 720, bitrate: 200 },
+            { height: 720, bitrate: 100 },
+            { height: 720, bitrate: 50 },
+            { height: 480, bitrate: 300 },
+        ]);
+    });
+
+    it("must sort with default value (example 1)", () => {
+        const itemsMissing = [
+            { height: 480, bitrate: 300 },
+            { height: 720, bitrate: 100 },
+            { height: 720 },
+            { height: 720, bitrate: 200 },
+        ];
+
+        itemsMissing.sort(sortByMultiple(["height", "bitrate"], false, { bitrate: 999 })).must.eql([
+            { height: 720 }, // bitrate assumed to be 999
+            { height: 720, bitrate: 200 },
+            { height: 720, bitrate: 100 },
+            { height: 480, bitrate: 300 },
+        ]);
+    });
+
+    it("must sort with default value (example 2)", () => {
+        const itemsMissing = [
+            { height: 480, bitrate: 300 },
+            { height: 720, bitrate: 100 },
+            { height: 720 },
+            { height: 720, bitrate: 200 },
+        ];
+
+        itemsMissing.sort(sortByMultiple(["height", "bitrate"], true, { bitrate: 1 })).must.eql([
+            { height: 480, bitrate: 300 },
+            { height: 720 }, // bitrate assumed to be 1
+            { height: 720, bitrate: 100 },
+            { height: 720, bitrate: 200 },
+        ]);
+    });
+
+    it("must sort each prop order separately", () => {
+        items.sort(sortByMultiple(["height", "bitrate"], { height: true, bitrate: false })).must.eql([
+            { height: 480, bitrate: 300 },
+            { height: 720, bitrate: 200 },
+            { height: 720, bitrate: 100 },
+            { height: 720, bitrate: 50 },
+        ]);
+    });
+
+    it("must sort each prop order separately (with missing)", () => {
+        const itemsMissing = [
+            { height: 480, bitrate: 300 },
+            { height: 720, bitrate: 100 },
+            { height: 720 },
+            { height: 720, bitrate: 200 },
+        ];
+
+        itemsMissing.sort(
+            sortByMultiple(["height", "bitrate"], { height: true, bitrate: false }, { bitrate: 150 }),
+        ).must.eql([
+            { height: 480, bitrate: 300 },
+            { height: 720, bitrate: 200 },
+            { height: 720 }, // bitrate assumed to be 150
+            { height: 720, bitrate: 100 },
+        ]);
+    });
+});

package/src/sortByMultiple.ts

@@ -0,0 +1,57 @@
+/**
+ * Returns a function that can be used as a callback to `.sort()` method. Returned function will sort array by given
+ * properties.
+ *
+ * @param propertyNames - name of the properties to sort by, in order of priority
+ * @param ascending - should sort be ascending? Pass boolean or object with boolean values for each property
+ * @param defaultValues - values to use when properties are not defined in one of the objects
+ *
+ * @example:
+ * ```
+ * const videos = [
+ *   { height: 480, bitrate: 300 },
+ *   { height: 720, bitrate: 100 },
+ *   { height: 720 },
+ *   { height: 720, bitrate: 200 },
+ * ];
+ * // Sort by height ascending, then by bitrate descending, and set default bitrate to 150
+ * itemsMissing.sort(sortByMultiple(["height", "bitrate"], { height: true, bitrate: false }, { bitrate: 150 }));
+ * // Result:
+ * [
+ *   { height: 480, bitrate: 300 },
+ *   { height: 720, bitrate: 200 },
+ *   { height: 720 }, // bitrate assumed to be 150
+ *   { height: 720, bitrate: 100 },
+ * ]
+ * ```
+ */
+const sortByMultiple = <
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    T extends Record<string | number | symbol, any>,
+    K extends (keyof T)[],
+>(
+    propertyNames: K,
+    ascending: boolean | Record<K[number], boolean> = true,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    defaultValues?: Partial<Record<K[number], any>>, // Force defaultValues to use only keys from K
+): ((a: T, b: T) => number) => (a: T, b: T) => {
+    for (const propertyName of propertyNames) {
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+        const asc = typeof ascending === "boolean" ? ascending : (ascending[propertyName] ?? true);
+        const aBiggerValue = asc ? 1 : -1; // eslint-disable-line @typescript-eslint/no-magic-numbers
+        const bBiggerValue = asc ? -1 : 1; // eslint-disable-line @typescript-eslint/no-magic-numbers
+
+        const aValue = a[propertyName] ?? defaultValues?.[propertyName];
+        const bValue = b[propertyName] ?? defaultValues?.[propertyName];
+
+        if (aValue !== bValue) {
+            // @ts-expect-error Too dynamic for TS
+            return (aValue > bValue ? aBiggerValue : bBiggerValue);
+        }
+    }
+    return 0;
+};
+
+export {
+    sortByMultiple,
+};