effect-io-ai

Package: effect
Module: Channel

Channel.fail

Constructs a channel that fails immediately with the specified error.

Example (Failing with an error)

import { Channel } from "effect"

// Create a channel that fails with a string error
const failedChannel = Channel.fail("Something went wrong")

// Create a channel that fails with a custom error
class CustomError extends Error {
  constructor(message: string) {
    super(message)
    this.name = "CustomError"
  }
}
const customErrorChannel = Channel.fail(new CustomError("Custom error"))

// Use in error handling by piping to another channel
const channelWithFallback = Channel.concatWith(
  failedChannel,
  () => Channel.succeed("fallback value")
)

Signature

declare const fail: <E>(error: E) => Channel<never, E, never>

Source

Since v2.0.0