effect-io-ai

Package: effect
Module: Effect

Effect.failSync

Creates an Effect that represents a recoverable error using a lazy evaluation.

When to use

Use to defer computing a recoverable error value until the effect is run.

Details

The error-producing function is evaluated each time the effect is executed.

Example (Lazily creating failures)

import { Data, Effect } from "effect"

class ProgramError extends Data.TaggedError("ProgramError")<{ readonly failedAt: Date }> {}

const program = Effect.failSync(() => new ProgramError({ failedAt: new Date() }))

Effect.runPromiseExit(program).then(console.log)
// Output: { _id: 'Exit', _tag: 'Failure', cause: ... }

Signature

declare const failSync: <E>(evaluate: LazyArg<E>) => Effect<never, E>

Source

Since v2.0.0