<A, E>(self: Stream<A, E>): AsyncIterable<A>Converts a stream to an AsyncIterable for for await...of consumption.
Example (Converting to an async iterable)
import { Stream } from "effect"
const stream = Stream.make(1, 2, 3)
const collect = async () => {
const iterable = Stream.toAsyncIterable(stream)
const values: Array<number> = []
for await (const value of iterable) {
values.push(value)
}
console.log(values)
}
collect()
// [ 1, 2, 3 ]destructors
Source effect/Stream.ts:114342 lines
export const const toAsyncIterable: <A, E>(
self: Stream<A, E>
) => AsyncIterable<A>
Converts a stream to an AsyncIterable for for await...of consumption.
Example (Converting to an async iterable)
import { Stream } from "effect"
const stream = Stream.make(1, 2, 3)
const collect = async () => {
const iterable = Stream.toAsyncIterable(stream)
const values: Array<number> = []
for await (const value of iterable) {
values.push(value)
}
console.log(values)
}
collect()
// [ 1, 2, 3 ]
toAsyncIterable = <function (type parameter) A in <A, E>(self: Stream<A, E>): AsyncIterable<A>A, function (type parameter) E in <A, E>(self: Stream<A, E>): AsyncIterable<A>E>(self: Stream<A, E>(parameter) self: {
channel: Channel.Channel<Arr.NonEmptyReadonlyArray<A>, E, void, unknown, unknown, unknown, R>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
interface Stream<out A, out E = never, out R = never>A Stream<A, E, R> describes a program that can emit many A values, fail
with E, and require R.
Details
Streams are pull-based with backpressure and emit chunks to amortize effect
evaluation. They support monadic composition and error handling similar to
Effect, adapted for multiple values.
Example (Creating and consuming streams)
import { Console, Effect, Stream } from "effect"
const program = Effect.gen(function*() {
yield* Stream.make(1, 2, 3).pipe(
Stream.map((n) => n * 2),
Stream.runForEach((n) => Console.log(n))
)
})
Effect.runPromise(program)
// Output:
// 2
// 4
// 6
Stream<function (type parameter) A in <A, E>(self: Stream<A, E>): AsyncIterable<A>A, function (type parameter) E in <A, E>(self: Stream<A, E>): AsyncIterable<A>E>): interface AsyncIterable<T, TReturn = any, TNext = any>AsyncIterable<function (type parameter) A in <A, E>(self: Stream<A, E>): AsyncIterable<A>A> =>
const toAsyncIterableWith: {
<XR>(context: Context.Context<XR>): <
A,
E,
R extends XR
>(
self: Stream<A, E, R>
) => AsyncIterable<A>
<A, E, XR, R extends XR>(
self: Stream<A, E, R>,
context: Context.Context<XR>
): AsyncIterable<A>
}
self: Stream<A, E>(parameter) self: {
channel: Channel.Channel<Arr.NonEmptyReadonlyArray<A>, E, void, unknown, unknown, unknown, R>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
import ContextContext.empty())