effect-io-ai

Package: effect
Module: Stream

Stream.Do

The “do simulation” in Effect allows you to write code in a more declarative style, similar to the “do notation” in other programming languages. It provides a way to define variables and perform operations on them using functions like bind and let.

Here’s how the do simulation works:

1. Start the do simulation using the Do value
2. Within the do simulation scope, you can use the bind function to define variables and bind them to Stream values
3. You can accumulate multiple bind statements to define multiple variables within the scope
4. Inside the do simulation scope, you can also use the let function to define variables and bind them to simple values

Example

import * as assert from "node:assert"
import { Chunk, Effect, pipe, Stream } from "effect"

const result = pipe(
  Stream.Do,
  Stream.bind("x", () => Stream.succeed(2)),
  Stream.bind("y", () => Stream.succeed(3)),
  Stream.let("sum", ({ x, y }) => x + y)
)
assert.deepStrictEqual(Effect.runSync(Stream.runCollect(result)), Chunk.of({ x: 2, y: 3, sum: 5 }))

See

• bindTo
• bind
• bindEffect
• let

Signature

declare const Do: Stream<{}, never, never>

Source

Since v2.0.0