effect-io-ai

Package: effect
Module: Exit

Exit.Exit

Represents the result of an Effect computation.

When to use

Use when you need to synchronously inspect whether an Effect computation succeeded or failed.

Details

An Exit<A, E> is either Success<A, E> containing a value of type A, or Failure<A, E> containing a Cause<E> describing why the computation failed.

Since Exit is also an Effect, you can yield it inside Effect.gen.

Example (Pattern matching on an Exit)

import { Exit } from "effect"

const success: Exit.Exit<number> = Exit.succeed(42)
const failure: Exit.Exit<number, string> = Exit.fail("error")

const result = Exit.match(success, {
  onSuccess: (value) => `Got value: ${value}`,
  onFailure: (cause) => `Got error: ${cause}`
})

See

• Success for the success case
• Failure for the failure case
• match for pattern matching

Signature

type Exit<A, E> = Success<A, E> | Failure<A, E>

Source

Since v2.0.0