Options
All
  • Public
  • Public/Protected
  • All
Menu

Module maxBy

Index

References

Functions Math

References

Renames and re-exports __type

Math Functions

  • maxBy<T>(array: ArrayLike<T>, iteratee?: any): T
  • maxBy(array: any, iteratee?: any): any
  • 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).

    since

    5.8.0

    example
    const objects = [{ 'n': 1 }, { 'n': 2 }]

    maxBy(objects, ({ n }) => n)
    // => { 'n': 2 }

    Type parameters

    • T

    Parameters

    • array: ArrayLike<T>

      The array to iterate over.

    • Optional iteratee: any

      The iteratee invoked per element.

    Returns T

    Returns the maximum value.

  • Parameters

    • array: any
    • Optional iteratee: any

    Returns any