Skip to main content
Module

std/collections/max_by.ts>maxBy

Deno standard library
Go to Latest
function maxBy
import { maxBy } from "https://deno.land/std@0.146.0/collections/max_by.ts";

Returns the first element that is the largest value of the given function or undefined if there are no elements.

Example:

import { maxBy } from "https://deno.land/std@0.146.0/collections/max_by.ts";
import { assertEquals } from "https://deno.land/std@0.146.0/testing/asserts.ts";

const people = [
    { name: 'Anna', age: 34 },
    { name: 'Kim', age: 42 },
    { name: 'John', age: 23 },
];

const personWithMaxAge = maxBy(people, i => i.age);

assertEquals(personWithMaxAge, { name: 'Kim', age: 42 });

Parameters

array: readonly T[]
selector: (el: T) => number

Returns

T | undefined

Parameters

array: readonly T[]
selector: (el: T) => string

Returns

T | undefined

Parameters

array: readonly T[]
selector: (el: T) => bigint

Returns

T | undefined

Parameters

array: readonly T[]
selector: (el: T) => Date

Returns

T | undefined

Parameters

array: readonly T[]
selector:
| ((el: T) => number)
| ((el: T) => string)
| ((el: T) => bigint)
| ((el: T) => Date)

Returns

T | undefined