Function maxBy

  • This method is like _.max except that it accepts iteratee which is invoked for each element in array to generate the criterion by which the value is ranked. The iteratee is invoked with one argument: (value).

    Example

    var objects = [{ 'n': 1 }, { 'n': 2 }];

    _.maxBy(objects, function(o) { return o.n; });
    // => { 'n': 2 }

    // using the `_.property` iteratee shorthand
    _.maxBy(objects, 'n');
    // => { 'n': 2 }

    Type Parameters

    • T

    Parameters

    • collection: undefined | null | List<T>
    • Optional iteratee: ValueIteratee<T>

      The iteratee invoked per element.

    Returns undefined | T

    Returns the maximum value.

Generated using TypeDoc