minBy (Functional Programming)

Creates a function that returns the value with the smallest computed score. Use it with pipe.

const result = pipe(array, minBy(getValue));

INFO

Prefer the original es-toolkit minBy in ordinary code. Use this fp variant when composing transformations with pipe.

Usage

minBy calls getValue for each value in the piped array and returns the value with the smallest result. If the array is empty, it returns undefined.

import { minBy, pipe } from 'es-toolkit/fp';

pipe(
  [{ score: 10 }, { score: 30 }, { score: 20 }],
  minBy(item => item.score)
); // => { score: 10 }

Parameters

• getValue ((item: T) => number): The function that returns the value used for comparison.

Returns

((array: readonly T[]) => T | undefined): A function that maps a readonly T[] to the minimum item, or undefined.