maxBy | /collections/mod.ts | std@0.116.0

function maxBy

import { maxBy } from "https://dotland.deno.dev/std@0.116.0/collections/mod.ts";

maxBy<T>(array: readonly T[], selector: (el: T) => number): T | undefined

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

maxBy<T>(array: readonly T[], selector: (el: T) => string): T | undefined

maxBy<T>(array: readonly T[], selector: (el: T) => bigint): T | undefined

maxBy<T>(array: readonly T[], selector: (el: T) => Date): T | undefined

maxBy<T>(array: readonly T[], selector:

| ((el: T) => number)

| ((el: T) => string)

| ((el: T) => bigint)

| ((el: T) => Date)

): T | undefined

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.116.0/collections/mod.ts";
import { assertEquals } from "https://deno.land/std@0.116.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 });

| ((el: T) => bigint)

| ((el: T) => Date)

Returns

T | undefined