effect-io-ai

Package: effect
Module: Result

Result.Failure

The failure variant of Result. Wraps an error of type E.

Details

• Access the error via the .failure property
• Use isFailure to narrow a Result to Failure
• Create with fail

Example (Accessing the failure value)

import { Result } from "effect"

const failure = Result.fail("Network error")

if (Result.isFailure(failure)) {
  console.log(failure.failure)
  // Output: "Network error"
}

See

• fail to create a Failure
• isFailure to narrow the type
• Success for the other variant

Signature

export interface Failure<out A, out E> extends Pipeable, Inspectable {
  readonly _tag: "Failure"
  readonly _op: "Failure"
  readonly failure: E
  readonly [TypeId]: {
    readonly _A: Covariant<E>
    readonly _E: Covariant<A>
  }
  [Symbol.iterator](): ResultIterator<Result<A, E>>
  [Unify.typeSymbol]?: unknown
  [Unify.unifySymbol]?: ResultUnify<this>
  [Unify.ignoreSymbol]?: ResultUnifyIgnore
}

Source

Since v4.0.0