<A, E, R>(self: Stream<A, E, R>): Stream<A, E, Exclude<R, Scope.Scope>>Runs a stream that requires Scope in a managed scope, ensuring its
finalizers are run when the stream completes.
Example (Scoping a stream)
import { Console, Effect, Stream } from "effect"
const stream = Stream.scoped(
Stream.fromEffect(
Effect.acquireRelease(
Console.log("acquire").pipe(Effect.as("resource")),
() => Console.log("release")
)
)
)
Effect.runPromise(Stream.runCollect(stream)).then(console.log)
// acquire
// release
// [ "resource" ]export const const scoped: <A, E, R>(
self: Stream<A, E, R>
) => Stream<A, E, Exclude<R, Scope.Scope>>
Runs a stream that requires Scope in a managed scope, ensuring its
finalizers are run when the stream completes.
Example (Scoping a stream)
import { Console, Effect, Stream } from "effect"
const stream = Stream.scoped(
Stream.fromEffect(
Effect.acquireRelease(
Console.log("acquire").pipe(Effect.as("resource")),
() => Console.log("release")
)
)
)
Effect.runPromise(Stream.runCollect(stream)).then(console.log)
// acquire
// release
// [ "resource" ]
scoped = <function (type parameter) A in <A, E, R>(self: Stream<A, E, R>): Stream<A, E, Exclude<R, Scope.Scope>>A, function (type parameter) E in <A, E, R>(self: Stream<A, E, R>): Stream<A, E, Exclude<R, Scope.Scope>>E, function (type parameter) R in <A, E, R>(self: Stream<A, E, R>): Stream<A, E, Exclude<R, Scope.Scope>>R>(
self: Stream<A, E, R>(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, R>(self: Stream<A, E, R>): Stream<A, E, Exclude<R, Scope.Scope>>A, function (type parameter) E in <A, E, R>(self: Stream<A, E, R>): Stream<A, E, Exclude<R, Scope.Scope>>E, function (type parameter) R in <A, E, R>(self: Stream<A, E, R>): Stream<A, E, Exclude<R, Scope.Scope>>R>
): 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, R>(self: Stream<A, E, R>): Stream<A, E, Exclude<R, Scope.Scope>>A, function (type parameter) E in <A, E, R>(self: Stream<A, E, R>): Stream<A, E, Exclude<R, Scope.Scope>>E, type Exclude<T, U> = T extends U
? never
: T
Exclude from T those types that are assignable to U
Exclude<function (type parameter) R in <A, E, R>(self: Stream<A, E, R>): Stream<A, E, Exclude<R, Scope.Scope>>R, import ScopeScope.type Scope.Scope = /*unresolved*/ anyScope>> => const fromChannel: <
Arr extends Arr.NonEmptyReadonlyArray<any>,
E,
R
>(
channel: Channel.Channel<
Arr,
E,
void,
unknown,
unknown,
unknown,
R
>
) => Stream<
Arr extends Arr.NonEmptyReadonlyArray<infer A>
? A
: never,
E,
R
>
Creates a stream from a array-emitting Channel.
Example (Creating a stream from an array-emitting channel)
import { Channel, Console, Effect, Stream } from "effect"
const program = Effect.gen(function*() {
const channel = Channel.succeed([1, 2, 3] as const)
const stream = Stream.fromChannel(channel)
const result = yield* Stream.runCollect(stream)
yield* Console.log(result)
})
// Output: [ 1, 2, 3 ]
fromChannel(import ChannelChannel.scoped(self: Stream<A, E, R>(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; <…;
}
Stream<out A, out E = never, out R = never>.channel: Channel.Channel<Arr.NonEmptyReadonlyArray<A>, E, void, unknown, unknown, unknown, R>(property) Stream<out A, out E = never, out R = never>.channel: {
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; <…;
}