effect-io-ai

Package: effect
Module: Effect

Effect.matchCause

Handles failures by matching the cause of failure.

When to use

Use when you need to fold an Effect while the failure handler inspects the full Cause.

Details

The matchCause function allows you to handle failures with access to the full cause of the failure within a fiber.

Example (Matching on success or failure causes)

import { Cause, Effect } from "effect"

const task = Effect.fail("Something went wrong")

const program = Effect.matchCause(task, {
  onFailure: (cause) => `Failed: ${Cause.squash(cause)}`,
  onSuccess: (value) => `Success: ${value}`
})

Effect.runPromise(program).then(console.log)
// Output: "Failed: Error: Something went wrong"

See

• matchCauseEffect if you need to perform side effects in the handlers.
• match if you don’t need to handle the cause of the failure.

Signature

declare const matchCause: { <E, A2, A, A3>(options: { readonly onFailure: (cause: Cause.Cause<E>) => A2; readonly onSuccess: (a: A) => A3; }): <R>(self: Effect<A, E, R>) => Effect<A2 | A3, never, R>; <A, E, R, A2, A3>(self: Effect<A, E, R>, options: { readonly onFailure: (cause: Cause.Cause<E>) => A2; readonly onSuccess: (a: A) => A3; }): Effect<A2 | A3, never, R>; }

Source

Since v2.0.0