std/collections/max_with.ts

Deno standard library
Go to Latest
function maxWith
import { maxWith } from "https://deno.land/std@0.139.0/collections/max_with.ts?s=maxWith";

Returns the first element having the largest value according to the provided comparator or undefined if there are no elements.

The comparator is expected to work exactly like one passed to Array.sort, which means that comparator(a, b) should return a negative number if a < b, a positive number if a > b and 0 if a == b.

Example:

import { maxWith } from "https://deno.land/std@0.139.0/collections/mod.ts";
import { assertEquals } from "https://deno.land/std@0.139.0/testing/asserts.ts";

const people = ["Kim", "Anna", "John", "Arthur"];
const largestName = maxWith(people, (a, b) => a.length - b.length);

assertEquals(largestName, "Arthur");

Parameters

array: readonly T[][src]
comparator: (a: T, b: T) => number[src]

Returns

T | undefined[src]