Class CompatResultAsync<T, E>

await yields CompatResult so .isOk() / .value / .match() work without .resolve().

Type Parameters

Implements

PromiseLike<CompatResult<T, E>>

Index

Methods

andTee andThen chain flatMap isErr isOk map mapErr match orElse orTee resolve then toCore unwrapOr combine err fromInner fromPromise fromSafePromise fromThrowable ok

Methods

andTee

andTee(fn: (value: T) => void | Promise<void>): CompatResultAsync<T, E>
Parameters
- fn: (value: T) => void | Promise<void>
Returns CompatResultAsync<T, E>
- Defined in packages/result/src/compat/neverthrow.ts:242

andThen

andThen<R extends AnyAsyncOrSyncResult>(
fn: (value: T) => R,
): CompatResultAsync<UnwrapOk<R>, E | UnwrapErr<R>>
Type Parameters
- R extends AnyAsyncOrSyncResult
Parameters
- fn: (value: T) => R
Returns CompatResultAsync<UnwrapOk<R>, E | UnwrapErr<R>>
- Defined in packages/result/src/compat/neverthrow.ts:196

chain

chain<R extends AnyAsyncOrSyncResult>(
fn: (value: T) => R,
): CompatResultAsync<UnwrapOk<R>, E | UnwrapErr<R>>
Type Parameters
- R extends AnyAsyncOrSyncResult
Parameters
- fn: (value: T) => R
Returns CompatResultAsync<UnwrapOk<R>, E | UnwrapErr<R>>
- Defined in packages/result/src/compat/neverthrow.ts:207

flatMap

flatMap<R extends AnyAsyncOrSyncResult>(
fn: (value: T) => R,
): CompatResultAsync<UnwrapOk<R>, E | UnwrapErr<R>>
Type Parameters
- R extends AnyAsyncOrSyncResult
Parameters
- fn: (value: T) => R
Returns CompatResultAsync<UnwrapOk<R>, E | UnwrapErr<R>>
- Defined in packages/result/src/compat/neverthrow.ts:211

isErr

isErr(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/result/src/compat/neverthrow.ts:234

isOk

isOk(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/result/src/compat/neverthrow.ts:230

map

map<U>(fn: (value: T) => U): CompatResultAsync<U, E>
Type Parameters
- U
Parameters
- fn: (value: T) => U
Returns CompatResultAsync<U, E>
- Defined in packages/result/src/compat/neverthrow.ts:188

mapErr

mapErr<F>(fn: (error: E) => F): CompatResultAsync<T, F>
Type Parameters
- F
Parameters
- fn: (error: E) => F
Returns CompatResultAsync<T, F>
- Defined in packages/result/src/compat/neverthrow.ts:192

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/compat/neverthrow.ts:238

orElse

orElse<R extends AnyAsyncOrSyncResult>(
fn: (error: E) => R,
): CompatResultAsync<T | UnwrapOk<R>, UnwrapErr<R>>
Type Parameters
- R extends AnyAsyncOrSyncResult
Parameters
- fn: (error: E) => R
Returns CompatResultAsync<T | UnwrapOk<R>, UnwrapErr<R>>
- Defined in packages/result/src/compat/neverthrow.ts:215

orTee

orTee(fn: (error: E) => void | Promise<void>): CompatResultAsync<T, E>
Parameters
- fn: (error: E) => void | Promise<void>
Returns CompatResultAsync<T, E>
- Defined in packages/result/src/compat/neverthrow.ts:248

resolve

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

then

then<R1 = CompatResult<T, E>, R2 = never>(
    onfulfilled?:
        | ((value: CompatResult<T, E>) => R1 | PromiseLike<R1>)
        | null,
    onrejected?: ((reason: unknown) => R2 | PromiseLike<R2>) | null,
): Promise<R1 | R2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- R1 = CompatResult<T, E>
- R2 = never
Parameters
- Optionalonfulfilled: ((value: CompatResult<T, E>) => R1 | PromiseLike<R1>) | null
  The callback to execute when the Promise is resolved.
- Optionalonrejected: ((reason: unknown) => R2 | PromiseLike<R2>) | null
  The callback to execute when the Promise is rejected.
Returns Promise<R1 | R2>
A Promise for the completion of which ever callback is executed.
Implementation of PromiseLike.then
- Defined in packages/result/src/compat/neverthrow.ts:174

toCore

toCore(): ResultAsync<T, E>
Returns ResultAsync<T, E>
- Defined in packages/result/src/compat/neverthrow.ts:132

unwrapOr

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

`Static`combine

combine<const R extends readonly CompatResultAsync<unknown, unknown>[]>(
results: R,
): CompatResultAsync<AsyncTupleOk<R>, AsyncTupleErr<R>>
Type Parameters
- const R extends readonly CompatResultAsync<unknown, unknown>[]
Parameters
- results: R
Returns CompatResultAsync<AsyncTupleOk<R>, AsyncTupleErr<R>>
- Defined in packages/result/src/compat/neverthrow.ts:162

`Static`err

err<T = never, E = unknown>(error: E): CompatResultAsync<T, E>
Type Parameters
- T = never
- E = unknown
Parameters
- error: E
Returns CompatResultAsync<T, E>
- Defined in packages/result/src/compat/neverthrow.ts:140

`Static`fromInner

fromInner<T, E>(inner: ResultAsync<T, E>): CompatResultAsync<T, E>
Type Parameters
- T
- E
Parameters
- inner: ResultAsync<T, E>
Returns CompatResultAsync<T, E>
- Defined in packages/result/src/compat/neverthrow.ts:128

`Static`fromPromise

fromPromise<T, E>(
promise: PromiseLike<T>,
onReject: (error: unknown) => E,
): CompatResultAsync<T, E>
Type Parameters
- T
- E
Parameters
- promise: PromiseLike<T>
- onReject: (error: unknown) => E
Returns CompatResultAsync<T, E>
- Defined in packages/result/src/compat/neverthrow.ts:144

`Static`fromSafePromise

fromSafePromise<T, E = never>(promise: PromiseLike<T>): CompatResultAsync<T, E>
Type Parameters
- T
- E = never
Parameters
- promise: PromiseLike<T>
Returns CompatResultAsync<T, E>
- Defined in packages/result/src/compat/neverthrow.ts:151

`Static`fromThrowable

fromThrowable<A extends readonly unknown[], U, F>(
fn: (...args: A) => Promise<U>,
onThrow: (error: unknown) => F,
): (...args: A) => CompatResultAsync<U, F>
Type Parameters
- A extends readonly unknown[]
- U
- F
Parameters
- fn: (...args: A) => Promise<U>
- onThrow: (error: unknown) => F
Returns (...args: A) => CompatResultAsync<U, F>
- Defined in packages/result/src/compat/neverthrow.ts:155

`Static`ok

ok<T, E = never>(value: T): CompatResultAsync<T, E>
Type Parameters
- T
- E = never
Parameters
- value: T
Returns CompatResultAsync<T, E>
- Defined in packages/result/src/compat/neverthrow.ts:136

Class CompatResultAsync<T, E>

Type Parameters

Implements

Index

Methods

Methods

andTee

Parameters

Returns CompatResultAsync<T, E>

andThen

Type Parameters

Parameters

Returns CompatResultAsync<UnwrapOk<R>, E | UnwrapErr<R>>

chain

Type Parameters

Parameters

Returns CompatResultAsync<UnwrapOk<R>, E | UnwrapErr<R>>

flatMap

Type Parameters

Parameters

Returns CompatResultAsync<UnwrapOk<R>, E | UnwrapErr<R>>

isErr

Returns Promise<boolean>

isOk

Returns Promise<boolean>

map

Type Parameters

Parameters

Returns CompatResultAsync<U, E>

mapErr

Type Parameters

Parameters

Returns CompatResultAsync<T, F>

match

Type Parameters

Parameters

Returns Promise<U1 | U2>

orElse

Type Parameters

Parameters

Returns CompatResultAsync<T | UnwrapOk<R>, UnwrapErr<R>>

orTee

Parameters

Returns CompatResultAsync<T, E>

resolve

Returns Promise<Result<T, E>>

then

Type Parameters

Parameters

Returns Promise<R1 | R2>

toCore

Returns ResultAsync<T, E>

unwrapOr

Type Parameters

Parameters

Returns Promise<T | U>

Staticcombine

Type Parameters

Parameters

Returns CompatResultAsync<AsyncTupleOk<R>, AsyncTupleErr<R>>

Staticerr

Type Parameters

Parameters

Returns CompatResultAsync<T, E>

StaticfromInner

Type Parameters

Parameters

Returns CompatResultAsync<T, E>

StaticfromPromise

Type Parameters

Parameters

Returns CompatResultAsync<T, E>

StaticfromSafePromise

Type Parameters

Parameters

Returns CompatResultAsync<T, E>

StaticfromThrowable

Type Parameters

Parameters

Returns (...args: A) => CompatResultAsync<U, F>

`Static`combine

`Static`err

`Static`fromInner

`Static`fromPromise

`Static`fromSafePromise

`Static`fromThrowable

`Static`ok