Newer version available
You’re viewing the API reference for version 3.3.0, but the latest version is 3.6.1. The latest version include may important updates and fixes.
View Latest Versionfunction each
thefrontside/effectionfunction each<T>(stream: Stream<T, unknown>): Operation<Iterable<T>>
Consume an effection stream using a simple for-of loop.
Given any stream, you can access its values sequentially using the each()
operation just as you would use for await of loop with an async iterable:
function* logvalues(stream) {
for (let value of yield* each(stream)) {
console.log(value);
yield* each.next()
}
}
You must always invoke each.next at the end of each iteration of the loop,
including if the interation ends with a continue statement.
Note that just as with async iterators, there is no way to consume the
TClose value of a stream using the for-each loop.
Type Parameters
T
- the type of each value in the stream.
Parameters
stream: Stream<T, unknown>
- the stream to iterate
Return Type
Operation<Iterable<T>>
an operation to iterate stream