Class ResultAsync<T, E>

Type Parameters

Implements

PromiseLike<Result<T, E>>

Index

Constructors

constructor

new ResultAsync<T, E>(res: Promise<Result<T, E>>): ResultAsync<T, E>
Type Parameters
- T
- E
Parameters
- res: Promise<Result<T, E>>
Returns ResultAsync<T, E>
- Defined in node_modules/neverthrow/dist/index.d.ts:7

Properties

`Private` _promise

_promise: any

Methods

andThen

andThen<R extends Result<unknown, unknown>>(f: ((t: T) => R)): ResultAsync<InferOkTypes<R>, E | InferErrTypes<R>>
Type Parameters
- R extends Result<unknown, unknown>
Parameters
- f: ((t: T) => R)
 - - (t: T): R
 - Parameters
 t: T
 Returns R
Returns ResultAsync<InferOkTypes<R>, E | InferErrTypes<R>>
- Defined in node_modules/neverthrow/dist/index.d.ts:17
andThen<R extends ResultAsync<unknown, unknown>>(f: ((t: T) => R)): ResultAsync<InferAsyncOkTypes<R>, E | InferAsyncErrTypes<R>>
Type Parameters
- R extends ResultAsync<unknown, unknown>
Parameters
- f: ((t: T) => R)
 - - (t: T): R
 - Parameters
 t: T
 Returns R
Returns ResultAsync<InferAsyncOkTypes<R>, E | InferAsyncErrTypes<R>>
- Defined in node_modules/neverthrow/dist/index.d.ts:18
andThen<U, F>(f: ((t: T) => Result<U, F> | ResultAsync<U, F>)): ResultAsync<U, E | F>
Type Parameters
- U
- F
Parameters
- f: ((t: T) => Result<U, F> | ResultAsync<U, F>)
 - - (t: T): Result<U, F> | ResultAsync<U, F>
 - Parameters
 t: T
 Returns Result<U, F> | ResultAsync<U, F>
Returns ResultAsync<U, E | F>
- Defined in node_modules/neverthrow/dist/index.d.ts:19

map

map<A>(f: ((t: T) => A | Promise<A>)): ResultAsync<A, E>
Type Parameters
- A
Parameters
- f: ((t: T) => A | Promise<A>)
 - - (t: T): A | Promise<A>
 - Parameters
 t: T
 Returns A | Promise<A>
Returns ResultAsync<A, E>
- Defined in node_modules/neverthrow/dist/index.d.ts:15

mapErr

mapErr(f: ((e: E) => U | Promise)): ResultAsync<T, U>
Type Parameters
- U
Parameters
- f: ((e: E) => U | Promise)
 - - (e: E): U | Promise
 - Parameters
 e: E
 Returns U | Promise
Returns ResultAsync<T, U>
- Defined in node_modules/neverthrow/dist/index.d.ts:16

match

match<A>(ok: ((t: T) => A), _err: ((e: E) => A)): Promise<A>
Type Parameters
- A
Parameters
- ok: ((t: T) => A)
 - - (t: T): A
 - Parameters
 t: T
 Returns A
- _err: ((e: E) => A)
 - - (e: E): A
 - Parameters
 e: E
 Returns A
Returns Promise<A>
- Defined in node_modules/neverthrow/dist/index.d.ts:23

orElse

orElse<R extends Result<T, unknown>>(f: ((e: E) => R)): ResultAsync<T, InferErrTypes<R>>
Type Parameters
- R extends Result<T, unknown>
Parameters
- f: ((e: E) => R)
 - - (e: E): R
 - Parameters
 e: E
 Returns R
Returns ResultAsync<T, InferErrTypes<R>>
- Defined in node_modules/neverthrow/dist/index.d.ts:20
orElse<R extends ResultAsync<T, unknown>>(f: ((e: E) => R)): ResultAsync<T, InferAsyncErrTypes<R>>
Type Parameters
- R extends ResultAsync<T, unknown>
Parameters
- f: ((e: E) => R)
 - - (e: E): R
 - Parameters
 e: E
 Returns R
Returns ResultAsync<T, InferAsyncErrTypes<R>>
- Defined in node_modules/neverthrow/dist/index.d.ts:21
orElse<A>(f: ((e: E) => Result<T, A> | ResultAsync<T, A>)): ResultAsync<T, A>
Type Parameters
- A
Parameters
- f: ((e: E) => Result<T, A> | ResultAsync<T, A>)
 - - (e: E): Result<T, A> | ResultAsync<T, A>
 - Parameters
 e: E
 Returns Result<T, A> | ResultAsync<T, A>
Returns ResultAsync<T, A>
- Defined in node_modules/neverthrow/dist/index.d.ts:22

safeUnwrap

safeUnwrap(): AsyncGenerator<Err<never, E>, T, unknown>
Emulates Rust's ? operator in safeTry's body. See also safeTry.

Returns AsyncGenerator<Err<never, E>, T, unknown>
- Defined in node_modules/neverthrow/dist/index.d.ts:28

then

then<A, B>(successCallback?: ((res: Result<T, E>) => A | PromiseLike<A>), failureCallback?: ((reason: unknown) => B | PromiseLike)): PromiseLike<A | B>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- A
- B
Parameters
- Optional successCallback: ((res: Result<T, E>) => A | PromiseLike<A>)
 The callback to execute when the Promise is resolved.
 - - (res: Result<T, E>): A | PromiseLike<A>
 - Parameters
 res: Result<T, E>
 Returns A | PromiseLike<A>
- Optional failureCallback: ((reason: unknown) => B | PromiseLike)
 The callback to execute when the Promise is rejected.
 - - (reason: unknown): B | PromiseLike
 - Parameters
 reason: unknown
 Returns B | PromiseLike
Returns PromiseLike<A | B>
A Promise for the completion of which ever callback is executed.
Implementation of PromiseLike.then
- Defined in node_modules/neverthrow/dist/index.d.ts:29

unwrapOr

unwrapOr<A>(t: A): Promise<T | A>
Type Parameters
- A
Parameters
- t: A
Returns Promise<T | A>
- Defined in node_modules/neverthrow/dist/index.d.ts:24

`Static` combine

combine<T extends readonly [ResultAsync<unknown, unknown>, ResultAsync<unknown, unknown>]>(asyncResultList: T): CombineResultAsyncs<T>
Type Parameters
- T extends readonly [ResultAsync<unknown, unknown>, ResultAsync<unknown, unknown>]
Parameters
- asyncResultList: T
Returns CombineResultAsyncs<T>
- Defined in node_modules/neverthrow/dist/index.d.ts:11
combine<T extends readonly ResultAsync<unknown, unknown>[]>(asyncResultList: T): CombineResultAsyncs<T>
Type Parameters
- T extends readonly ResultAsync<unknown, unknown>[]
Parameters
- asyncResultList: T
Returns CombineResultAsyncs<T>
- Defined in node_modules/neverthrow/dist/index.d.ts:12

`Static` combineWithAllErrors

combineWithAllErrors<T extends readonly [ResultAsync<unknown, unknown>, ResultAsync<unknown, unknown>]>(asyncResultList: T): CombineResultsWithAllErrorsArrayAsync<T>
Type Parameters
- T extends readonly [ResultAsync<unknown, unknown>, ResultAsync<unknown, unknown>]
Parameters
- asyncResultList: T
Returns CombineResultsWithAllErrorsArrayAsync<T>
- Defined in node_modules/neverthrow/dist/index.d.ts:13
combineWithAllErrors<T extends readonly ResultAsync<unknown, unknown>[]>(asyncResultList: T): CombineResultsWithAllErrorsArrayAsync<T>
Type Parameters
- T extends readonly ResultAsync<unknown, unknown>[]
Parameters
- asyncResultList: T
Returns CombineResultsWithAllErrorsArrayAsync<T>
- Defined in node_modules/neverthrow/dist/index.d.ts:14

`Static` fromPromise

fromPromise<T, E>(promise: PromiseLike<T>, errorFn: ((e: unknown) => E)): ResultAsync<T, E>
Type Parameters
- T
- E
Parameters
- promise: PromiseLike<T>
- errorFn: ((e: unknown) => E)
 - - (e: unknown): E
 - Parameters
 e: unknown
 Returns E
Returns ResultAsync<T, E>
- Defined in node_modules/neverthrow/dist/index.d.ts:9

`Static` fromSafePromise

fromSafePromise<T, E>(promise: PromiseLike<T>): ResultAsync<T, E>
Type Parameters
- T
- E = never
Parameters
- promise: PromiseLike<T>
Returns ResultAsync<T, E>
- Defined in node_modules/neverthrow/dist/index.d.ts:8

`Static` fromThrowable

fromThrowable<A extends readonly any[], R, E>(fn: ((...args: A) => Promise<R>), errorFn?: ((err: unknown) => E)): ((...args: A) => ResultAsync<R, E>)
Type Parameters
- A extends readonly any[]
- R
- E
Parameters
- fn: ((...args: A) => Promise<R>)
 - - (...args: A): Promise<R>
 - Parameters
 Rest ...args: A
 Returns Promise<R>
- Optional errorFn: ((err: unknown) => E)
 - - (err: unknown): E
 - Parameters
 err: unknown
 Returns E
Returns ((...args: A) => ResultAsync<R, E>)
- - (...args: A): ResultAsync<R, E>
 - Parameters
 - Rest ...args: A
 Returns ResultAsync<R, E>
- Defined in node_modules/neverthrow/dist/index.d.ts:10

Class ResultAsync<T, E>

Type Parameters

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ResultAsync<T, E>

Properties

Private _promise

Methods

andThen

Type Parameters

Parameters

Parameters

Returns R

Returns ResultAsync<InferOkTypes<R>, E | InferErrTypes<R>>

Type Parameters

Parameters

Parameters

Returns R

Returns ResultAsync<InferAsyncOkTypes<R>, E | InferAsyncErrTypes<R>>

Type Parameters

Parameters

Parameters

Returns Result<U, F> | ResultAsync<U, F>

Returns ResultAsync<U, E | F>

map

Type Parameters

Parameters

Parameters

Returns A | Promise<A>

Returns ResultAsync<A, E>

mapErr

Type Parameters

Parameters

Parameters

Returns U | Promise<U>

Returns ResultAsync<T, U>

match

Type Parameters

Parameters

Parameters

Returns A

Parameters

Returns A

Returns Promise<A>

orElse

Type Parameters

Parameters

Parameters

Returns R

Returns ResultAsync<T, InferErrTypes<R>>

Type Parameters

Parameters

Parameters

Returns R

Returns ResultAsync<T, InferAsyncErrTypes<R>>

Type Parameters

Parameters

Parameters

Returns Result<T, A> | ResultAsync<T, A>

Returns ResultAsync<T, A>

safeUnwrap

Returns AsyncGenerator<Err<never, E>, T, unknown>

then

Type Parameters

Parameters

Parameters

Returns A | PromiseLike<A>

Parameters

Returns B | PromiseLike<B>

Returns PromiseLike<A | B>

unwrapOr

Type Parameters

Parameters

`Private` _promise

`Static` combine

`Static` combineWithAllErrors

`Static` fromPromise

`Static` fromSafePromise

`Static` fromThrowable