@mll-lab/js-utils 2.18.0 → 2.19.0

package/dist/array.d.ts

@@ -1,3 +1,4 @@
+import { Maybe } from './types';
 export declare type NonEmptyArray<T> = Array<T> & {
     0: T;
 };
@@ -40,3 +41,10 @@ export declare function toggleElement<T>(array: Array<T>, element: T): Array<T>;
  *          returns sorted array [Jan, Mar, Dec]
  */
 export declare function sortByArray<T extends string | number>(subject: Array<T>, recipe: Array<T>): Array<T>;
+/**
+ * Takes a function that maps the values to sort and returns a compare function
+ * using `String.prototype.localeCompare`, usable in `Array.sort` or similar APIs.
+ *
+ * null, undefined and the empty string are not distinguished and first in sort order.
+ */
+export declare function makeStringCompareFn<TSortable>(map: (sortable: TSortable) => Maybe<string>): (a: TSortable, b: TSortable) => number;

package/dist/index.common.js

@@ -9491,6 +9491,20 @@ function sortByArray(subject, recipe) {
     }
     return lodash.sortBy(subject, (value) => recipe.indexOf(value));
 }
+/**
+ * Takes a function that maps the values to sort and returns a compare function
+ * using `String.prototype.localeCompare`, usable in `Array.sort` or similar APIs.
+ *
+ * null, undefined and the empty string are not distinguished and first in sort order.
+ */
+function makeStringCompareFn(map) {
+    return (a, b) => {
+        var _a, _b;
+        const mappedA = (_a = map(a)) !== null && _a !== void 0 ? _a : '';
+        const mappedB = (_b = map(b)) !== null && _b !== void 0 ? _b : '';
+        return mappedA.localeCompare(mappedB);
+    };
+}
 
 function toInteger(dirtyNumber) {
   if (dirtyNumber === null || dirtyNumber === true || dirtyNumber === false) {
@@ -15484,6 +15498,7 @@ exports.isURL = isURL;
 exports.isWord = isWord;
 exports.joinNonEmpty = joinNonEmpty;
 exports.last = last;
+exports.makeStringCompareFn = makeStringCompareFn;
 exports.mapSequentially = mapSequentially;
 exports.parseDate = parseDate;
 exports.parseDotlessDate = parseDotlessDate;