Function maxBy

  • It will iterate through each element of the provided values array and return the result of invoking iteratee function/property for each element to produce the desired number, to then be compared with other result numbers to find the maximum value.

    Type Parameters

    • Value

    Parameters

    • values: Value[]

      The array to iterate over.

    • iteratee: IterateeT<Value>

      The function/property to get the value per element.

    Returns number

    The maximum value.

    Since

    1.0.0

    Example

    maxBy([1, 2, 3], number => number); // => 3
    

    Example

    maxBy([{ a: 1 }, { a: 2 }, { a: 3 }], ({ a }) => a); // => 3
    

    Example

    maxBy([{ a: 1 }, { a: 2 }, { a: 3 }], "a"); // => 3