@epikodelabs/streamix / aggregates/src/public-api / every
Function: every()
every<
T>(predicate):Operator<T,boolean>
Defined in: projects/libraries/streamix/aggregates/src/lib/operators/every.ts:22
Creates a stream operator that tests if all values from the source stream satisfy a predicate.
This operator consumes the source stream and applies the provided predicate function to each value.
- If the
predicatereturns a truthy value for every element until the source stream completes, the operator emitstrue. - If the
predicatereturns a falsy value for any element, the operator immediately emitsfalseand then completes, effectively "short-circuiting" the evaluation.
This is a "pull-based" equivalent of Array.prototype.every and is useful for validating data streams. The operator will emit only a single boolean value before it completes. When the stream completes without emitting any items, it still emits true.
Type Parameters
T
T = any
The type of the values in the source stream.
Parameters
predicate
(value, index) => MaybePromise<boolean>
The function to test each value. It receives the value and its index. It can be synchronous or asynchronous.
Returns
Operator<T, boolean>
An Operator instance that can be used in a stream's pipe method.