Skip to main content

Function: maxWith()

Returns an iterable containing a maximum value of iterable by comparing the numerical values of each value, as defined by fn, if iterable contains at least one value. Otherwise, returns an empty iterable.

Example​

console.log(
  pipe(
    [`eating`, `sleeping`, `yawning`],
    maxWith(value => value.length),
    get,
  ),
)
//=> sleeping

maxWith(fn, iterable)​

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

Returns an iterable containing a maximum value of iterable by comparing the numerical values of each value, as defined by fn, if iterable contains at least one value. Otherwise, returns an empty iterable.

Type Parameters​

• Value

Parameters​

• fn

• iterable: Iterable<Value, any, any>

Returns​

Iterable<Value, any, any>

Example​

console.log(
  pipe(
    [`eating`, `sleeping`, `yawning`],
    maxWith(value => value.length),
    get,
  ),
)
//=> sleeping

Defined in​

statistics.d.ts:809

maxWith(fn)​

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

Returns an iterable containing a maximum value of iterable by comparing the numerical values of each value, as defined by fn, if iterable contains at least one value. Otherwise, returns an empty iterable.

Type Parameters​

• Value

Parameters​

• fn

Returns​

Function

Parameters​

• iterable: Iterable<Value, any, any>

Returns​

Iterable<Value, any, any>

Example​

console.log(
  pipe(
    [`eating`, `sleeping`, `yawning`],
    maxWith(value => value.length),
    get,
  ),
)
//=> sleeping

Defined in​

statistics.d.ts:809