Options
All
  • Public
  • Public/Protected
  • All
Menu

Module array/maxBy

Index

References

Functions

References

Renames and re-exports maxBy

Functions

  • maxBy<T, R>(fn: ArrOrdFunc<T, R>, arr: ArrayLike<T>): T
  • maxBy<T, R>(fn: ArrOrdFunc<T, R>): (arr: ArrayLike<T>) => T
  • Return max value in array, depending on result of calling fn

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

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

    Type parameters

    Parameters

    • fn: ArrOrdFunc<T, R>

      The function invoked per element.

    • arr: ArrayLike<T>

    Returns T

    Returns the maximum value.

  • Return max value in array, depending on result of calling fn

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

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

    Type parameters

    Parameters

    • fn: ArrOrdFunc<T, R>

      The function invoked per element.

    Returns (arr: ArrayLike<T>) => T

    Returns the maximum value.

      • (arr: ArrayLike<T>): T
      • Parameters

        • arr: ArrayLike<T>

        Returns T

Generated using TypeDoc