Function max

  • Get the maximum element from an Iterable by comparing its elements using a Comparator.

    Example

    Find max number in Array

    const findMaxNumber = max(numberComparator);
    const maxNumber = findMaxNumber([1,2,3]);
    console.log(maxNumber); // 3

    Returns

    the maximum element, or undefined if the Iterable is empty

    Type Parameters

    • T

      the Iterable value type

    Parameters

    • comparator: Comparator<T>

      the Comparator to use

    • maxValueIsLess: ((valueA: T, valueB: T) => boolean) = ...
        • (valueA: T, valueB: T): boolean

        • Parameters

          • valueA: T
          • valueB: T

          Returns boolean

    Returns ((iterable: Iterable<T>) => undefined | T)

      • (iterable: Iterable<T>): undefined | T

      • Parameters

        Returns undefined | T

Settings

Member Visibility

Theme

Generated using TypeDoc