Class Result<T, E>

The Result type is an immutable representation of either success (Ok) or failure (Err).

Type Parameters

T = any
E = any

Index

Methods

[iterator] and andThen err flatten isErr isErrAnd isOk isOkAnd isSame map mapErr match ok or orElse toString transpose unwrap unwrapErr unwrapErrOr unwrapErrOrElse unwrapOr unwrapOrElse Err from isResult isSame Ok try tryAsync

Methods

[iterator]

"[iterator]"(): Generator<T, void, unknown>
Returns an iterator over the possibly contained value.

The iterator yields one value if the result is Ok, otherwise none.

Returns Generator<T, void, unknown>
- Defined in src/result.ts:143

and

and<BT, BE = any>(resultB: Result<BT, BE>): Result<BT, E | BE>
Type Parameters
- BT
- BE = any
Parameters
- resultB: Result<BT, BE>
Returns Result<BT, E | BE>
- Defined in src/result.ts:189

andThen

andThen<BT, BE = any>(
getResultB: (value: T) => Result<BT, BE>,
thisArg?: any,
): Result<BT, E | BE>
Type Parameters
- BT
- BE = any
Parameters
- getResultB: (value: T) => Result<BT, BE>
 
 A function that returns a Result
- OptionalthisArg: any
 
 If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns Result<BT, E | BE>

Err if the Result is Err, otherwise calls getOptionB with the wrapped value and returns the result.
- Defined in src/result.ts:199

err

err(): Option<E>
Converts from Result<T, E> to Option<E> and discarding the value, if any.

Returns Option<E>
- Defined in src/result.ts:282

flatten

flatten(): Result<UnwrapOk<T, T>, E | UnwrapErr<E, E>>
Converts from Option<Option<T>> to Option<T>

Returns Result<UnwrapOk<T, T>, E | UnwrapErr<E, E>>
- Defined in src/result.ts:227

isErr

isErr(): boolean
Returns boolean

true if the Result is an Err.
- Defined in src/result.ts:159

isErrAnd

isErrAnd(predicate: (error: E) => boolean, thisArg?: any): boolean
Parameters
- predicate: (error: E) => boolean
- OptionalthisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns boolean

true if the Result is an Err and and the error inside of it matches a predicate.
- Defined in src/result.ts:175

isOk

isOk(): boolean
Returns boolean

true if the Result is an Ok.
- Defined in src/result.ts:152

isOkAnd

isOkAnd(predicate: (value: T) => boolean, thisArg?: any): boolean
Parameters
- predicate: (value: T) => boolean
- OptionalthisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns boolean

true if the Result is an Ok and and the value inside of it matches a predicate.
- Defined in src/result.ts:167

isSame

isSame(other: unknown): boolean
Whether this Ok value or Err error is the same as the other Result.
Parameters
- other: unknown
  
  Another Result or any value
Returns boolean

true if the other is an Result and the Ok value or Err error is the same as this via Object.is.
- Defined in src/result.ts:185

map

map(fn: (value: T) => U, thisArg?: any): Result<U, E>
Maps an Result<T, E> to Result<U, E> by applying a function to a contained Ok value, leaving an Err value untouched.
Type Parameters
- U
Parameters
- fn: (value: T) => U
 
 A function that maps a value to another value
- OptionalthisArg: any
 
 If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns Result<U, E>

Err if the Result is Err, otherwise returns Ok(fn(value)).
- Defined in src/result.ts:240

mapErr

mapErr(fn: (error: E) => U, thisArg?: any): Result<T, U>
Maps a Result<T, E> to Result<T, F> by applying a function to a contained Err value, leaving an Ok value untouched.

This function can be used to pass through a successful result while handling an error.
Type Parameters
- U
Parameters
- fn: (error: E) => U
 
 A function that maps a error to another error
- OptionalthisArg: any
 
 If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns Result<T, U>

Ok if the Result is Ok, otherwise returns Err(fn(error)).
- Defined in src/result.ts:253

match

match(Ok: (value: T) => U, Err: (error: E) => U): U
Extract the value from an Result in a way that handles both the Ok and Err cases.
Type Parameters
- U
Parameters
- Ok: (value: T) => U
 
 A function that returns a value if the Result is a Ok.
- Err: (error: E) => U
 
 A function that returns a value if the Result is a Err.
Returns U

The value returned by the provided function.
- Defined in src/result.ts:373

ok

ok(): Option<T>
Converts from Result<T, E> to Option<T> and discarding the error, if any.

Returns Option<T>
- Defined in src/result.ts:275

or

or<BT, BE = any>(resultB: Result<BT, BE>): Result<T | BT, E | BE>
Type Parameters
- BT
- BE = any
Parameters
- resultB: Result<BT, BE>
 
 A Result
Returns Result<T | BT, E | BE>

the Result if it is Ok, otherwise returns resultB.

Arguments passed to or are eagerly evaluated; if you are passing the result of a function call, it is recommended to use orElse, which is lazily evaluated.
- Defined in src/result.ts:210

orElse

orElse<BT, BE = any>(
getResultB: () => Result<BT, BE>,
thisArg?: any,
): Result<T | BT, E | BE>
Type Parameters
- BT
- BE = any
Parameters
- getResultB: () => Result<BT, BE>
 
 A function that returns an Result
- OptionalthisArg: any
 
 If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns Result<T | BT, E | BE>

the Result if it contains a value, otherwise calls getResultB and returns the result.
- Defined in src/result.ts:220

toString

toString(): string
Returns string
- Defined in src/result.ts:377

transpose

transpose(): Option<Result<UnwrapOption<T>, E>>
Transposes a Result(Option) into Option(Result).
- Ok(Some(_)) will be mapped to `Some(Ok(_))
- Err(_) will be mapped to Some(Err(_)).
- Ok(_) will be mapped to Some(Ok(_)).
Returns Option<Result<UnwrapOption<T>, E>>
- Defined in src/result.ts:264

unwrap

unwrap(message?: string): T
Parameters
- message: string = "called `Result.unwrap()` on an `Err`"
  Optional Error message
Returns T

the contained Ok value.

Throws

if the value is an Err.
- Defined in src/result.ts:293

unwrapErr

unwrapErr(message?: string): E
Parameters
- message: string = "called `Result.unwrapErr()` on an `Ok` value"
  Optional Error message
Returns E

the contained Err error.

Throws

if the error is an Ok.
- Defined in src/result.ts:332

unwrapErrOr

unwrapErrOr(): E | undefined
Returns E | undefined

the contained Err error or undefined otherwise.

Arguments passed to unwrapErrOr are eagerly evaluated; if you are passing the result of a function call, it is recommended to use unwrapErrOrElse, which is lazily evaluated.
- Defined in src/result.ts:344
unwrapErrOr(defaultError: U): E | U
Type Parameters
- U
Parameters
- defaultError: U
 default error
Returns E | U

the contained Err error or a provided default.

Arguments passed to unwrapErrOr are eagerly evaluated; if you are passing the result of a function call, it is recommended to use unwrapErrOrElse, which is lazily evaluated.
- Defined in src/result.ts:352

unwrapErrOrElse

unwrapErrOrElse(fn: () => U, thisArg?: any): E | U
Type Parameters
- U
Parameters
- fn: () => U
 A function that computes a default value.
- OptionalthisArg: any
 
 If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns E | U

the contained Err error or computes it from a closure.
- Defined in src/result.ts:362

unwrapOr

unwrapOr(): T | undefined
Returns T | undefined

the contained Ok value or undefined otherwise.
- Defined in src/result.ts:303
unwrapOr(defaultValue: U): T | U
Type Parameters
- U
Parameters
- defaultValue: U
 default value
Returns T | U

the contained Ok value or a provided default.

Arguments passed to unwrapOr are eagerly evaluated; if you are passing the result of a function call, it is recommended to use unwrapOrElse, which is lazily evaluated.
- Defined in src/result.ts:311

unwrapOrElse

unwrapOrElse(fn: () => U, thisArg?: any): T | U
Type Parameters
- U
Parameters
- fn: () => U
 A function that computes a default value.
- OptionalthisArg: any
 
 If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns T | U

the contained Ok value or computes it from a closure.
- Defined in src/result.ts:321

`Static`Err

Err<E, T = any>(error: E): Result<T, E>
Type Parameters
- E
- T = any
Parameters
- error: E
 
 An error of type E
Returns Result<T, E>

Wrap an error into an Result.
- Defined in src/result.ts:28

`Static`from

from<T = any, E extends Error = Error>(source: T | E): Result<T, E>
Err if the value is an Error.
Type Parameters
- T = any
- E extends Error = Error
Parameters
- source: T | E
 
 A value of type T
Returns Result<T, E>
- Defined in src/result.ts:37
from<T = any, E = any>(
 source: T | E,
 predicate: (source: T | E) => source is T,
 thisArg?: any,
): Result<T, E>
OK if the value satisfies the predicate, otherwise Err
Type Parameters
- T = any
- E = any
Parameters
- source: T | E
 Source value
- predicate: (source: T | E) => source is T
 
 A function that returns true if the value satisfies the predicate, otherwise false
- OptionalthisArg: any
 
 If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns Result<T, E>
- Defined in src/result.ts:45
from<T = any, E = any>(
 source: T | E,
 predicate: (source: T | E) => boolean,
 thisArg?: any,
): Result<T, E>
OK if the value satisfies the predicate, otherwise Err
Type Parameters
- T = any
- E = any
Parameters
- source: T | E
 Source value
- predicate: (source: T | E) => boolean
 
 A function that returns true if the value satisfies the predicate, otherwise false
- OptionalthisArg: any
 
 If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns Result<T, E>
- Defined in src/result.ts:57

`Static`isResult

isResult<T, E>(maybeResult: unknown): maybeResult is Result<T, E>
Type Parameters
- T
- E
Parameters
- maybeResult: unknown
 
 A value that might be an Result
Returns maybeResult is Result<T, E>

true if the given value is an Result.
- Defined in src/result.ts:109

`Static`isSame

isSame(a: unknown, b: unknown): boolean
Parameters
- a: unknown
  
  An Result or any value
- b: unknown
  
  An Result or any value
Returns boolean

true if the both are Result and the Ok value or Err error are the same via Object.is.
- Defined in src/result.ts:119

`Static`Ok

Ok<T, E = any>(value: T): Result<T, E>
Type Parameters
- T
- E = any
Parameters
- value: T
 
 A value of type T
Returns Result<T, E>

Wrap a value into an Result.
- Defined in src/result.ts:20

`Static`try

try<T = any, E = any, TArgs extends any[] = []>(
fn: (...args: TArgs) => T,
...args: TArgs,
): Result<T, E>
Ok if the fn returns a value, Err if the fn throws.
Type Parameters
- T = any
- E = any
- TArgs extends any[] = []
Parameters
- fn: (...args: TArgs) => T
- ...args: TArgs
Returns Result<T, E>

Ok with the returned value or Err with the exception error.
- Defined in src/result.ts:77

`Static`tryAsync

tryAsync<T = any, E = any, TArgs extends any[] = []>(
fn: (...args: TArgs) => T | Promise<T>,
...args: TArgs,
): Promise<Result<Awaited<T>, E>>
Ok if the fn returned Promise resolves a value, Err if the fn throws or the Promise rejected.
Type Parameters
- T = any
- E = any
- TArgs extends any[] = []
Parameters
- fn: (...args: TArgs) => T | Promise<T>
- ...args: TArgs
Returns Promise<Result<Awaited<T>, E>>

Ok with the resolved value or Err with the exception error or the rejected value.
- Defined in src/result.ts:93

Class Result<T, E>

Type Parameters

Index

Methods

Methods

[iterator]

Returns Generator<T, void, unknown>

and

Type Parameters

Parameters

Returns Result<BT, E | BE>

andThen

Type Parameters

Parameters

Returns Result<BT, E | BE>

err

Returns Option<E>

flatten

Returns Result<UnwrapOk<T, T>, E | UnwrapErr<E, E>>

isErr

Returns boolean

isErrAnd

Parameters

Returns boolean

isOk

Returns boolean

isOkAnd

Parameters

Returns boolean

isSame

Parameters

Returns boolean

map

Type Parameters

Parameters

Returns Result<U, E>

mapErr

Type Parameters

Parameters

Returns Result<T, U>

match

Type Parameters

Parameters

Returns U

ok

Returns Option<T>

or

Type Parameters

Parameters

Returns Result<T | BT, E | BE>

orElse

Type Parameters

Parameters

Returns Result<T | BT, E | BE>

toString

Returns string

transpose

Returns Option<Result<UnwrapOption<T>, E>>

unwrap

Parameters

Returns T

Throws

unwrapErr

Parameters

Returns E

Throws

unwrapErrOr

Returns E | undefined

Type Parameters

Parameters

Returns E | U

unwrapErrOrElse

Type Parameters

Parameters

Returns E | U

unwrapOr

Returns T | undefined

Type Parameters

Parameters

Returns T | U

`Static`Err

`Static`from

`Static`isResult

`Static`isSame

`Static`Ok

`Static`try

`Static`tryAsync