Skip to content

min

Calculates the minimum of the input array, supporting the extraction of numeric values via an optional parameter getter (or directly using the numeric values of the array elements).

The getter is a field path of getByPath or a callback function, for extracting numerical values.

Added in v0.0.1

Usage

ts
import { min } from 'parsnip-kit'

min([1, 2, 3, 4]) // 1

min([{ value: 10 }, { value: 20 }], item => item.value) // 10

min([{ score: 85 }, { score: 95 }], 'score') // 85

API

Type Parameter

ArgTypeDescription
TType of input array

Arguments

ArgTypeOptionalDefaultDescription
dataT[]falseundefinedInput array
getterstring | ((item: T, index: number, arr: T[]) => number)trueundefinedFor extracting numerical values from array elements

Returns

Type
number