effect-io-ai

Package: effect
Module: TxQueue

TxQueue.fail

Fails the queue with the specified error, discarding any buffered items.

Details

The queue transitions directly to done with Cause.fail(error). Returns false if the queue was already closing or done.

Example (Failing queues)

import { Effect, TxQueue } from "effect"

const program = Effect.gen(function*() {
  const queue = yield* TxQueue.bounded<number, string>(10)

  // Fail the queue with an error
  const result = yield* TxQueue.fail(queue, "connection lost")
  console.log(result) // true
})

Signature

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

Source

Since v4.0.0