effect-io-ai

Package: effect
Module: Result

Result.getOrThrow

Extracts the success value or throws the raw failure value E.

When to use

Use when unchecked boundaries should turn failures into thrown exceptions.

Details

• Success<A> returns A
• Failure<E> throws E directly
• Use getOrThrowWith for a custom error object

Example (Unwrapping or throwing)

import { Result } from "effect"

console.log(Result.getOrThrow(Result.succeed(1)))
// Output: 1

// This would throw the string "error":
// Result.getOrThrow(Result.fail("error"))

See

• getOrThrowWith for custom error mapping
• getOrElse for a non-throwing alternative

Signature

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

Source

Since v2.0.0