maxOf | /collections/max_of.ts | std@0.223.0

Module

std/collections/max_of.ts>maxOf

The Deno Standard Library

denoland/deno_std

Latest

mod.ts (default module)

MergeRightOmitComplexes

MergeRightOmitComplexes

first_not_nullish_of.ts

function maxOf

import { maxOf } from "https://deno.land/std@0.223.0/collections/max_of.ts";

maxOf<T>(array: Iterable<T>, selector: (el: T) => number): number | undefined

Applies the given selector to all elements of the provided collection and returns the max value of all elements. If an empty array is provided the function will return undefined

maxOf<T>(array: Iterable<T>, selector: (el: T) => bigint): bigint | undefined

Applies the given selector to all elements of the provided collection and returns the max value of all elements. If an empty array is provided the function will return undefined

Examples

Example 1

import { maxOf } from "https://deno.land/std@0.223.0/collections/max_of.ts";
import { assertEquals } from "https://deno.land/std@0.223.0/assert/assert_equals.ts";

const inventory = [
  { name: "mustard", count: 2 },
  { name: "soy", count: 4 },
  { name: "tomato", count: 32 },
];

const maxCount = maxOf(inventory, (i) => i.count);

assertEquals(maxCount, 32);

Type Parameters

Parameters

array: Iterable<T>

selector: (el: T) => number

Returns

number | undefined

Applies the given selector to all elements of the provided collection and returns the max value of all elements. If an empty array is provided the function will return undefined

Examples

Example 1

import { maxOf } from "https://deno.land/std@0.223.0/collections/max_of.ts";
import { assertEquals } from "https://deno.land/std@0.223.0/assert/assert_equals.ts";

const inventory = [
  { name: "mustard", count: 2n },
  { name: "soy", count: 4n },
  { name: "tomato", count: 32n },
];

const maxCount = maxOf(inventory, (i) => i.count);

assertEquals(maxCount, 32n);