effect-io-ai

Package: effect
Module: Cause

Cause.ExceededCapacityError

An error indicating that a bounded resource (queue, pool, semaphore, etc.) has exceeded its capacity.

When to use

Use to model bounded-resource failures where an operation cannot proceed because capacity has been exhausted.

Details

Implements YieldableError.

Example (Creating and checking an ExceededCapacityError)

import { Cause } from "effect"

const error = new Cause.ExceededCapacityError("Queue full")
console.log(error._tag)    // "ExceededCapacityError"
console.log(error.message) // "Queue full"

Signature

export interface ExceededCapacityError extends YieldableError {
  readonly [ExceededCapacityErrorTypeId]: typeof ExceededCapacityErrorTypeId
  readonly _tag: "ExceededCapacityError"
}

Source

Since v4.0.0