All files / comparator/src falsyFirst.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
1x
1x
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4x
 
import { isFalsy } from "@benneq/object";
import { predicateComparator } from "./predicateComparator";
 
/**
 *
 * @example
 * Sort an array with {@link @benneq/object!Falsy} values first
 * ```ts
 * const array = ["b", 0, "a"];
 * array.sort(falsyFirst(stringComparator));
 * console.log(array); // [0, "a", "b"]
 * ```
 *
 * @typeParam T - the {@link Comparator} value type
 * @param comparator
 * @returns a {@link Comparator}
 */
export const falsyFirst = predicateComparator(isFalsy);