Skip to content

Function.unwrapOr

github-actions[bot] edited this page Nov 18, 2026 · 13 revisions

umt / unwrapOr

Function: unwrapOr()

unwrapOr<V, E, D>(result, defaultValue): V | D

Defined in: Error/unwrapOr.ts:22

Extracts the value from a successful Result, or returns the provided default value if the Result is an error.

Type Parameters

V

V

E

E

D

D = V

Parameters

result

Result<V, E>

The Result to unwrap.

defaultValue

D

The value returned when the Result is an error.

Returns

V | D

The success value, or the default value for an error Result.

Example

const success = { type: "success", value: 5 } as const;
unwrapOr(success, 0);
// 5

const error = { type: "error", error: new Error("fail") } as const;
unwrapOr(error, 0);
// 0

API

Classes

Interfaces

Type Aliases

Variables

Functions

Clone this wiki locally