effect-io-ai

Package: effect
Module: TxDeferred

TxDeferred.fail

Completes the deferred with a failure. Returns true if this was the first completion, false if already completed.

When to use

Use to complete a TxDeferred with a typed failure value.

Example (Completing with a failure)

import { Effect, TxDeferred } from "effect"

const program = Effect.gen(function*() {
  const deferred = yield* TxDeferred.make<number, string>()
  const first = yield* TxDeferred.fail(deferred, "boom")
  console.log(first) // true
  const second = yield* TxDeferred.fail(deferred, "boom2")
  console.log(second) // false
})

Signature

declare const fail: { <E>(error: E): <A>(self: TxDeferred<A, E>) => Effect.Effect<boolean>; <A, E>(self: TxDeferred<A, E>, error: E): Effect.Effect<boolean>; }

Source

Since v2.0.0