Skip to main content

Function: unwrapOr()

Call Signature​

unwrapOr<T, E>(result, defaultValue): T

Defined in: result/unwrap/index.ts:53

Extracts the value from an Ok Result or returns a default.

Type Parameters​

T​

T

E​

E

Parameters​

result​

Result<T, E>

The Result to unwrap

defaultValue​

T

Value to return if Result is Err

Returns​

T

The value from Ok or the default

Example​

// Data-first
unwrapOr(ok(42), 0) // => 42
unwrapOr(err('fail'), 0) // => 0

// Data-last (in pipe)
pipe(
  parseNumber('abc'),
  unwrapOr(0)
) // => 0

See​

unwrapOrElse - for lazy default computation

Call Signature​

unwrapOr<T>(defaultValue): <E>(result) => T

Defined in: result/unwrap/index.ts:54

Extracts the value from an Ok Result or returns a default.

Type Parameters​

T​

T

Parameters​

defaultValue​

T

Value to return if Result is Err

Returns​

The value from Ok or the default

<E>(result): T

Type Parameters​

E​

E

Parameters​

result​

Result<T, E>

Returns​

T

Example​

// Data-first
unwrapOr(ok(42), 0) // => 42
unwrapOr(err('fail'), 0) // => 0

// Data-last (in pipe)
pipe(
  parseNumber('abc'),
  unwrapOr(0)
) // => 0

See​

unwrapOrElse - for lazy default computation