Function maxBy

Alias

maxBy<T>(items, getValue): T
Finds the element in an array that has the maximum value when applying the getValue function to each element.
Type Parameters
- T
  The type of elements in the array.
Parameters
- items: readonly [T, T]
  The nonempty array of elements to search.
- getValue: ((element: T) => number)
  A function that selects a numeric value from each element.
  - - (element): number
    - Parameters
      element: T
      Returns number
Returns T
The element with the maximum value as determined by the getValue function.
Example
```
maxBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 3 }
maxBy([], x => x.a); // Returns: undefined
maxBy(
  [
    { name: 'john', age: 30 },
    { name: 'jane', age: 28 },
    { name: 'joe', age: 26 },
  ],
  x => x.age
); // Returns: { name: 'john', age: 30 }
```
- Defined in src/array.ts:333
maxBy<T>(items, getValue): T | undefined
Finds the element in an array that has the maximum value when applying the getValue function to each element.
Type Parameters
- T
  The type of elements in the array.
Parameters
- items: readonly T[]
  The array of elements to search.
- getValue: ((element: T) => number)
  A function that selects a numeric value from each element.
  - - (element): number
    - Parameters
      element: T
      Returns number
Returns T | undefined
The element with the maximum value as determined by the getValue function.
Example
```
maxBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 3 }
maxBy([], x => x.a); // Returns: undefined
maxBy(
  [
    { name: 'john', age: 30 },
    { name: 'jane', age: 28 },
    { name: 'joe', age: 26 },
  ],
  x => x.age
); // Returns: { name: 'john', age: 30 }
```
- Defined in src/array.ts:333

Function maxBy

Alias

Type Parameters

Parameters

Parameters

Returns number

Returns T

Example

Type Parameters

Parameters

Parameters

Returns number

Returns T | undefined

Example

Settings