effect-io-ai

Package: effect
Module: Result

Result.flip

Swaps the success and failure channels of a Result.

When to use

Use to swap channels when failure-focused operations are easier through success-oriented combinators.

Details

• Success<A> becomes Failure<A> (i.e., Result<E, A>)
• Failure<E> becomes Success<E> (i.e., Result<E, A>)
• Useful when you want to apply success-oriented operations (like map) to the error channel, then flip back

Example (Swapping channels)

import { Result } from "effect"

console.log(Result.flip(Result.succeed(42)))
// Output: { _tag: "Failure", failure: 42, ... }

console.log(Result.flip(Result.fail("error")))
// Output: { _tag: "Success", success: "error", ... }

See

• mapError to transform the error without swapping

Signature

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

Source

Since v2.0.0