effect-io-ai

Package: effect
Module: Result

Result.gen

Provides generator-based syntax for composing Result values sequentially.

When to use

Use when you need generator syntax to compose sequential Result computations instead of nested flatMap calls.

Details

• Use yield* to unwrap a Result inside the generator; if any yielded Result is a Failure, the generator short-circuits and returns that failure
• The return value of the generator is wrapped in Success
• Evaluated eagerly and synchronously (unlike Effect.gen)

Example (Composing multiple Results)

import { Result } from "effect"

const result = Result.gen(function*() {
  const a = yield* Result.succeed(1)
  const b = yield* Result.succeed(2)
  return a + b
})

console.log(result)
// Output: { _tag: "Success", success: 3, ... }

See

• flatMap for point-free sequential composition
• all to collect multiple independent Results

Signature

declare const gen: Gen.Gen<ResultTypeLambda>

Source

Since v2.0.0