unwrap API Reference

Signature

tsSignature

1
export function unwrap<T, E>(result: Result<T, E>): T;

tsImport

1
import { unwrap } from "@/lib/flow/core/result";
2
import { unwrap } from "@/lib/flow";

T

Success value type.

E

Expected error value type.

result

The success value.

Return type

T

Prefer typed recovery helpers for expected failures. `unwrap` is best reserved for tests,

boundaries that intentionally throw, or places where a failure is impossible by construction.

Explicit success-or-failure outcome used throughout Flow.

type

tsflow/core/result.ts:176-182

1
export function unwrap<T, E>(result: Result<T, E>): T {
2
  if (result.ok) {
3
    return result.value;
4
  }
5

6
  throw result.error;
7
}