Skip to content

Documentation / @eventkit/base / max

Function: max()

ts
function max<T>(comparer?): SingletonOperatorFunction<T, T>

Emits the maximum value emitted by the source observable. The source observable must emit a comparable type (numbers, strings, dates, etc.), or any type when a comparer function is provided.

Type Parameters

Type Parameter
T

Parameters

ParameterTypeDescription
comparer?(x, y) => numberA function that compares two values and returns a number; a positive number if the first value is greater than the second, a negative number if the first value is less than the second, or 0 if they are equal.

Returns

SingletonOperatorFunction<T, T>

Released under the MIT License.