Class ResultAsync<T, E>

Async result — public API never exposes Promise<Result<…>> directly; await via .resolve() or .match().

Type Parameters

Index

Constructors

constructor

Properties

run

Constructors

`Protected`constructor

new ResultAsync<T, E>(run: PromiseFactory<T, E>): ResultAsync<T, E>
Type Parameters
- T
- E
Parameters
- run: PromiseFactory<T, E>
Returns ResultAsync<T, E>
- Defined in packages/result/src/async.ts:39

Properties

`Protected` `Readonly`run

run: PromiseFactory<T, E>

Methods

andThen

andThen<U, F = E>(
    fn: (
        value: T,
    ) => ResultAsync<U, F> | Result<U, F> | { inner: Result<U, F> },
): ResultAsync<U, E | F>
Type Parameters
- U
- F = E
Parameters
- fn: (value: T) => ResultAsync<U, F> | Result<U, F> | { inner: Result<U, F> }
Returns ResultAsync<U, E | F>
- Defined in packages/result/src/async.ts:182

chain

chain<U, F = E>(
    fn: (
        value: T,
    ) => ResultAsync<U, F> | Result<U, F> | { inner: Result<U, F> },
): ResultAsync<U, E | F>
Type Parameters
- U
- F = E
Parameters
- fn: (value: T) => ResultAsync<U, F> | Result<U, F> | { inner: Result<U, F> }
Returns ResultAsync<U, E | F>
- Defined in packages/result/src/async.ts:188

flatMap

flatMap<U, F = E>(
    fn: (
        value: T,
    ) => ResultAsync<U, F> | Result<U, F> | { inner: Result<U, F> },
): ResultAsync<U, E | F>
Type Parameters
- U
- F = E
Parameters
- fn: (value: T) => ResultAsync<U, F> | Result<U, F> | { inner: Result<U, F> }
Returns ResultAsync<U, E | F>
- Defined in packages/result/src/async.ts:160

isErr

isErr(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/result/src/async.ts:240

isOk

isOk(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/result/src/async.ts:236

map

map<U>(fn: (value: T) => U): ResultAsync<U, E>
Type Parameters
- U
Parameters
- fn: (value: T) => U
Returns ResultAsync<U, E>
- Defined in packages/result/src/async.ts:152

mapErr

mapErr<F>(fn: (error: E) => F): ResultAsync<T, F>
Type Parameters
- F
Parameters
- fn: (error: E) => F
Returns ResultAsync<T, F>
- Defined in packages/result/src/async.ts:156

match

match<U1, U2 = U1>(
onOk: (value: T) => U1,
onErr: (error: E) => U2,
): Promise<U1 | U2>
Type Parameters
- U1
- U2 = U1
Parameters
- onOk: (value: T) => U1
- onErr: (error: E) => U2
Returns Promise<U1 | U2>
- Defined in packages/result/src/async.ts:244

orElse

orElse<F>(fn: (error: E) => ResultAsync<T, F> | Result<T, F>): ResultAsync<T, F>
Type Parameters
- F
Parameters
- fn: (error: E) => ResultAsync<T, F> | Result<T, F>
Returns ResultAsync<T, F>
- Defined in packages/result/src/async.ts:208

recover

recover<F>(
fn: (error: E) => ResultAsync<T, F> | Result<T, F>,
): ResultAsync<T, F>
Type Parameters
- F
Parameters
- fn: (error: E) => ResultAsync<T, F> | Result<T, F>
Returns ResultAsync<T, F>
- Defined in packages/result/src/async.ts:194

resolve

resolve(): Promise<Result<T, E>>
Returns Promise<Result<T, E>>
- Defined in packages/result/src/async.ts:250

tap

tap(fn: (value: T) => void): ResultAsync<T, E>
Parameters
- fn: (value: T) => void
Returns ResultAsync<T, E>
- Defined in packages/result/src/async.ts:212

tapErr

tapErr(fn: (error: E) => void): ResultAsync<T, E>
Parameters
- fn: (error: E) => void
Returns ResultAsync<T, E>
- Defined in packages/result/src/async.ts:222

then

then<R1 = Result<T, E>, R2 = never>(
onfulfilled?: ((value: Result<T, E>) => R1 | PromiseLike<R1>) | null,
onrejected?: ((reason: unknown) => R2 | PromiseLike<R2>) | null,
): Promise<R1 | R2>
Thenable shim — await ra resolves to a bare tagged-union Result<T, E>. Narrow with isOk(r) / isErr(r) to read .value / .error.
Type Parameters
- R1 = Result<T, E>
- R2 = never
Parameters
- Optionalonfulfilled: ((value: Result<T, E>) => R1 | PromiseLike<R1>) | null
- Optionalonrejected: ((reason: unknown) => R2 | PromiseLike<R2>) | null
Returns Promise<R1 | R2>
- Defined in packages/result/src/async.ts:259

unwrapOr

unwrapOr<U>(defaultValue: U): Promise<T | U>
Type Parameters
- U
Parameters
- defaultValue: U
Returns Promise<T | U>
- Defined in packages/result/src/async.ts:232

`Static`combine

combine<T, E>(results: readonly ResultAsync<T, E>[]): ResultAsync<T[], E>
Type Parameters
- T
- E
Parameters
- results: readonly ResultAsync<T, E>[]
Returns ResultAsync<T[], E>
- Defined in packages/result/src/async.ts:90

`Static`combineTuple

combineTuple<const R extends readonly ResultAsync<unknown, unknown>[]>(
results: R,
): CombineTupleAsync<R>
Type Parameters
- const R extends readonly ResultAsync<unknown, unknown>[]
Parameters
- results: R
Returns CombineTupleAsync<R>
- Defined in packages/result/src/async.ts:104

`Static`combineTupleParallel

combineTupleParallel<const R extends readonly ResultAsync<unknown, unknown>[]>(
results: R,
): CombineTupleAsync<R>
Like combineTuple, but starts every branch before awaiting (wall-clock parallel for independent IO). On failure, returns the first Err in input order.
Type Parameters
- const R extends readonly ResultAsync<unknown, unknown>[]
Parameters
- results: R
Returns CombineTupleAsync<R>
- Defined in packages/result/src/async.ts:130

`Static`defer

defer<T, E>(fn: () => Promise<Result<T, E>>): ResultAsync<T, E>
Defers work until resolve. Unlike fromPromise, nothing runs until the ResultAsync is resolved (e.g. by combineTuple / combineTupleParallel).
Type Parameters
- T
- E
Parameters
- fn: () => Promise<Result<T, E>>
Returns ResultAsync<T, E>
- Defined in packages/result/src/async.ts:66

`Static`err

err<T = never, E = unknown>(error: E): ResultAsync<T, E>
Type Parameters
- T = never
- E = unknown
Parameters
- error: E
Returns ResultAsync<T, E>
- Defined in packages/result/src/async.ts:76

`Static`fromPromise

fromPromise<T, E>(
promise: PromiseLike<T>,
onReject: (error: unknown) => E,
): ResultAsync<T, E>
Type Parameters
- T
- E
Parameters
- promise: PromiseLike<T>
- onReject: (error: unknown) => E
Returns ResultAsync<T, E>
- Defined in packages/result/src/async.ts:45

`Static`fromResult

fromResult<T, E>(result: Result<T, E>): ResultAsync<T, E>
Type Parameters
- T
- E
Parameters
- result: Result<T, E>
Returns ResultAsync<T, E>
- Defined in packages/result/src/async.ts:41

`Static`fromResultPromise

fromResultPromise<T, E>(
promise: Promise<Result<T, E>>,
onDefect?: (error: unknown) => UnexpectedError | E,
): ResultAsync<T, UnexpectedError | E>
Type Parameters
- T
- E
Parameters
- promise: Promise<Result<T, E>>
- OptionalonDefect: (error: unknown) => UnexpectedError | E
Returns ResultAsync<T, UnexpectedError | E>
See
fromAsync from @onrails/result/interop
- Defined in packages/result/src/async.ts:81

`Static`fromSafePromise

fromSafePromise<T, E = never>(promise: PromiseLike<T>): ResultAsync<T, E>
Type Parameters
- T
- E = never
Parameters
- promise: PromiseLike<T>
Returns ResultAsync<T, E>
- Defined in packages/result/src/async.ts:58

`Static`ok

ok<T>(value: T): ResultAsync<T, never>
Type Parameters
- T
Parameters
- value: T
Returns ResultAsync<T, never>
- Defined in packages/result/src/async.ts:70
ok<T, E>(value: T): ResultAsync<T, E>
Type Parameters
- T
- E
Parameters
- value: T
Returns ResultAsync<T, E>
- Defined in packages/result/src/async.ts:71

Class ResultAsync<T, E>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns ResultAsync<T, E>

Properties

Protected Readonlyrun

Methods

andThen

Type Parameters

Parameters

Returns ResultAsync<U, E | F>

chain

Type Parameters

Parameters

Returns ResultAsync<U, E | F>

flatMap

Type Parameters

Parameters

Returns ResultAsync<U, E | F>

isErr

Returns Promise<boolean>

isOk

Returns Promise<boolean>

map

Type Parameters

Parameters

Returns ResultAsync<U, E>

mapErr

Type Parameters

Parameters

Returns ResultAsync<T, F>

match

Type Parameters

Parameters

Returns Promise<U1 | U2>

orElse

Type Parameters

Parameters

Returns ResultAsync<T, F>

recover

Type Parameters

Parameters

Returns ResultAsync<T, F>

resolve

Returns Promise<Result<T, E>>

tap

Parameters

Returns ResultAsync<T, E>

tapErr

Parameters

Returns ResultAsync<T, E>

then

Type Parameters

Parameters

Returns Promise<R1 | R2>

unwrapOr

Type Parameters

Parameters

Returns Promise<T | U>

Staticcombine

Type Parameters

Parameters

Returns ResultAsync<T[], E>

StaticcombineTuple

Type Parameters

Parameters

Returns CombineTupleAsync<R>

StaticcombineTupleParallel

Type Parameters

Parameters

Returns CombineTupleAsync<R>

Staticdefer

Type Parameters

`Protected`constructor

`Protected` `Readonly`run

`Static`combine

`Static`combineTuple

`Static`combineTupleParallel

`Static`defer

`Static`err

`Static`fromPromise

`Static`fromResult

`Static`fromResultPromise

`Static`fromSafePromise

`Static`ok