(defect: unknown): Stream<never>The stream that dies with the specified defect.
Example (Dying with a defect)
import { Cause, Console, Effect, Exit, Stream } from "effect"
const defect = new Error("Boom")
const stream = Stream.die(defect)
const program = Effect.gen(function*() {
const exit = yield* Effect.exit(Stream.runCollect(stream))
const message = Exit.match(exit, {
onSuccess: () => "Exit.Success",
onFailure: (cause) => {
const reason = cause.reasons[0]
const defect = Cause.isDieReason(reason) ? String(reason.defect) : "Unexpected reason"
return `Exit.Failure(${defect})`
}
})
yield* Console.log(message)
})
Effect.runPromise(program)
// Output: Exit.Failure(Error: Boom)constructors
Source effect/Stream.ts:10101 lines
export const const die: (
defect: unknown
) => Stream<never>
The stream that dies with the specified defect.
Example (Dying with a defect)
import { Cause, Console, Effect, Exit, Stream } from "effect"
const defect = new Error("Boom")
const stream = Stream.die(defect)
const program = Effect.gen(function*() {
const exit = yield* Effect.exit(Stream.runCollect(stream))
const message = Exit.match(exit, {
onSuccess: () => "Exit.Success",
onFailure: (cause) => {
const reason = cause.reasons[0]
const defect = Cause.isDieReason(reason) ? String(reason.defect) : "Unexpected reason"
return `Exit.Failure(${defect})`
}
})
yield* Console.log(message)
})
Effect.runPromise(program)
// Output: Exit.Failure(Error: Boom)
die = (defect: unknowndefect: unknown): 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<never> => 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.die(defect: unknowndefect))Referenced by 1 symbols