Skip to main content

Function: minBy()

Returns an iterable containing a minimum value of iterable based on the fn Compare function if iterable contains at least one value. Otherwise, returns an empty iterable.

Example​

console.log(
  pipe(
    [`eating`, `sleeping`, `yawning`],
    minBy((a, b) => a.length - b.length),
    get,
  ),
)
//=> eating

minBy(fn, iterable)​

minBy<Value>(fn, iterable): Iterable<Value, any, any>

Returns an iterable containing a minimum value of iterable based on the fn Compare function if iterable contains at least one value. Otherwise, returns an empty iterable.

Type Parameters​

• Value

Parameters​

• fn: Compare<Value>

• iterable: Iterable<Value, any, any>

Returns​

Iterable<Value, any, any>

Example​

console.log(
  pipe(
    [`eating`, `sleeping`, `yawning`],
    minBy((a, b) => a.length - b.length),
    get,
  ),
)
//=> eating

Defined in​

statistics.d.ts:342

minBy(fn)​

minBy<Value>(fn): (iterable) => Iterable<Value, any, any>

Returns an iterable containing a minimum value of iterable based on the fn Compare function if iterable contains at least one value. Otherwise, returns an empty iterable.

Type Parameters​

• Value

Parameters​

• fn: Compare<Value>

Returns​

Function

Parameters​

• iterable: Iterable<Value, any, any>

Returns​

Iterable<Value, any, any>

Example​

console.log(
  pipe(
    [`eating`, `sleeping`, `yawning`],
    minBy((a, b) => a.length - b.length),
    get,
  ),
)
//=> eating

Defined in​

statistics.d.ts:342