All files / comparator/src mappingComparator.ts

100% Statements 5/5
100% Branches 0/0
100% Functions 4/4
100% Lines 4/4

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32                                                    3x 2x 3x 7x    
import { Mapper } from "@benneq/function";
import { Comparator } from "./_types";
 
/**
 * Creates a {@link Comparator} that maps the values using a
 * {@link @benneq/function!Mapper} before comparing them.
 *
 * @example
 * Sort `Person` objects by age
 * ```ts
 * const numberMappingComparator = mappingComparator(numberComparator);
 * const personByAgeComparator = numberMappingComparator<Person>(p => p.age);
 *
 * const array: Person[] = [
 *   { age: 2 },
 *   { age: 1 }
 * ];
 *
 * array.sort(personByAgeComparator);
 * console.log(array); // [{age:1}, {age:2}]
 * ```
 *
 * @typeParam R - the {@link Comparator} value type
 * @typeParam T - the mapped value type
 * @returns a {@link Comparator}
 */
export const mappingComparator =
  <R>(comparator: Comparator<R>) =>
  <T>(mapper: Mapper<T, R>): Comparator<T> => {
    return (valueA, valueB) => comparator(mapper(valueA), mapper(valueB));
  };