effect-io-ai

Package: effect
Module: Option

Option.getFailure

Converts a Result into an Option, keeping only the failure value.

When to use

Use when you need to discard a Result success and keep only the failure value as an Option.

Details

• Failure becomes Some with the failure value
• Success becomes None and the success value is discarded

Example (Extracting the failure side)

import { Option, Result } from "effect"

console.log(Option.getFailure(Result.succeed("ok")))
// Output: { _id: 'Option', _tag: 'None' }

console.log(Option.getFailure(Result.fail("err")))
// Output: { _id: 'Option', _tag: 'Some', value: 'err' }

See

• getSuccess for the opposite operation.

Signature

declare const getFailure: <A, E>(self: Result<A, E>) => Option<E>

Source

Since v4.0.0