for await, .on(), .filter(), .map(), .take(), .close(),
and Symbol.asyncDispose.
Only one consumer is allowed per stream instance. Calling .on() or
iterating a stream that is already being consumed throws an error.
Use .filter() / .map() / .take() to derive new streams before
consuming them.
Constructor
Parameters
AsyncIterable<T>
required
() => Promise<void>
Returns
TypedEventStream
Methods
asyncIterator
Returns
AsyncIterator<T>
close()
Returns
Promise<void>
filter()
Parameters
(event: T) => event
required
Returns
TypedEventStream
Parameters
(event: T) => boolean
required
Returns
TypedEventStream
map()
Parameters
(event: T) => U
required
Returns
TypedEventStream
on()
onError to handle callback or source errors; otherwise
errors are rethrown on the next microtask.
Parameters
(event: T) => void | Promise<void>
required
(error: unknown) => void
Returns
() => void
take()
count events, then close the parent stream.
count <= 0 returns an empty stream without consuming the parent.
Parameters
number
required
Returns
TypedEventStream