All files / comparator/src isLessThan.ts

100% Statements 4/4
100% Branches 0/0
100% Functions 3/3
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                                3x 1x 3x 3x    
import { Comparator } from "./_types";
 
/**
 * Checks if `valueA` is less than `valueB` using a {@link Comparator}.
 *
 * @example
 * ```
 * const isStringLessThan = isLessThan(stringComparator);
 * const result = isStringLessThan("aa", "ab");
 * console.log(result); // true
 * ```
 *
 * @typeParam T - the {@link Comparator} value type
 * @param comparator - the {@link Comparator} to use
 * @returns `true` if `valueA` is less than `valueB`, otherwise `false`
 */
export const isLessThan =
  <T>(comparator: Comparator<T>) =>
  (valueA: T, valueB: T): boolean => {
    return comparator(valueA, valueB) < 0;
  };