Module

std/collections/min_of.ts

Deno standard library
Go to Latest
File
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.// This module is browser compatible.
/** * Applies the given selector to all elements of the given collection and * returns the min value of all elements. If an empty array is provided the * function will return undefined * * Example: * * ```ts * import { minOf } from "https://deno.land/std@$STD_VERSION/collections/mod.ts" * import { assertEquals } from "https://deno.land/std@$STD_VERSION/testing/asserts.ts" * * const inventory = [ * { name: "mustard", count: 2 }, * { name: "soy", count: 4 }, * { name: "tomato", count: 32 }, * ]; * const minCount = minOf(inventory, (i) => i.count); * * assertEquals(minCount, 2); * ``` */export function minOf<T>( array: readonly T[], selector: (el: T) => number,): number | undefined;
export function minOf<T>( array: readonly T[], selector: (el: T) => bigint,): bigint | undefined;
export function minOf<T, S extends ((el: T) => number) | ((el: T) => bigint)>( array: readonly T[], selector: S,): ReturnType<S> | undefined { let minimumValue: ReturnType<S> | undefined = undefined;
for (const i of array) { const currentValue = selector(i) as ReturnType<S>;
if (minimumValue === undefined || currentValue < minimumValue) { minimumValue = currentValue; continue; }
if (Number.isNaN(currentValue)) { return currentValue; } }
return minimumValue;}