effect-io-ai

Package: effect
Module: Queue

Queue.fail

Fails the queue with an error. If the queue is already done, false is returned.

Example (Failing queues with an error)

import { Effect, Queue } from "effect"

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

  // Fail the queue with an error
  const failed = yield* Queue.fail(queue, "Something went wrong")
  console.log(failed) // true

  // Taking from the failed queue fails with the error
  const error = yield* Effect.flip(Queue.take(queue))
  console.log(error) // "Something went wrong"
})

Signature

declare const fail: <A, E>(self: Enqueue<A, E>, error: E) => Effect<boolean, never, never>

Source

Since v4.0.0