maxBy

maxBy<T>(xs, f): T extends Iterable<infer I> ? T extends readonly [unknown, ...unknown[]] ? T[number] : Maybe<I> : T

Calculate the maximum value of the given items by applying the function.

Example

maxBy([{ 'n': 1 }, { 'n': 2 }], x => x.n)
// => {n: 2}

Alternatives

• Lodash - maxBy

Type Parameters

• T extends Iterable<unknown>

The element type.

Parameters

xs

T

The values to check.

f

(item) => string | number | bigint

Returns

T extends Iterable<infer I> ? T extends readonly [unknown, ...unknown[]] ? T[number] : Maybe<I> : T

The maximum value of the traversable.