Interface EitherAsyncTypeRef

interface EitherAsyncTypeRef {
    all<L, R>(eas: readonly EitherAsync<L, R>[]): EitherAsync<L, R[]>;
    fromPromise<L, R>(f: () => PromiseLike<Either<L, R>>): EitherAsync<L, R>;
    lefts<L, R>(list: readonly EitherAsync<L, R>[]): Promise<L[]>;
    liftEither<L, R>(either: Either<L, R>): EitherAsync<L, R>;
    rights<L, R>(list: readonly EitherAsync<L, R>[]): Promise<R[]>;
    sequence<L, R>(eas: readonly EitherAsync<L, R>[]): EitherAsync<L, R[]>;
    <L, R>(
        runPromise: (helpers: EitherAsyncHelpers<L>) => PromiseLike<R>,
    ): EitherAsync<L, R>;
}

EitherAsyncTypeRef<L, R>(
runPromise: (helpers: EitherAsyncHelpers<L>) => PromiseLike<R>,
): EitherAsync<L, R>
Constructs an EitherAsync object from a function that takes an object full of helpers that let you lift things into the EitherAsync context and returns a Promise
Type Parameters
- L
- R
Parameters
- runPromise: (helpers: EitherAsyncHelpers<L>) => PromiseLike<R>
Returns EitherAsync<L, R>
- Defined in node_modules/purify-ts/EitherAsync.d.ts:9

Index

Methods

all fromPromise lefts liftEither rights sequence

Methods

all

all<L, R>(eas: readonly EitherAsync<L, R>[]): EitherAsync<L, R[]>
The same as EitherAsync.sequence, but it will run all async operations at the same time rather than sequentially
Type Parameters
- L
- R
Parameters
- eas: readonly EitherAsync<L, R>[]
Returns EitherAsync<L, R[]>
- Defined in node_modules/purify-ts/EitherAsync.d.ts:21

fromPromise

fromPromise<L, R>(f: () => PromiseLike<Either<L, R>>): EitherAsync<L, R>
Constructs an EitherAsync object from a function that returns an Either wrapped in a Promise
Type Parameters
- L
- R
Parameters
- f: () => PromiseLike<Either<L, R>>
Returns EitherAsync<L, R>
- Defined in node_modules/purify-ts/EitherAsync.d.ts:11

lefts

lefts<L, R>(list: readonly EitherAsync<L, R>[]): Promise<L[]>
Takes a list of EitherAsyncs and returns a Promise that will resolve with all Left values. Internally it uses Promise.all to wait for all results
Type Parameters
- L
- R
Parameters
- list: readonly EitherAsync<L, R>[]
Returns Promise<L[]>
- Defined in node_modules/purify-ts/EitherAsync.d.ts:15

liftEither

liftEither<L, R>(either: Either<L, R>): EitherAsync<L, R>
Constructs an EitherAsync object from an Either
Type Parameters
- L
- R
Parameters
- either: Either<L, R>
Returns EitherAsync<L, R>
- Defined in node_modules/purify-ts/EitherAsync.d.ts:13

rights

rights<L, R>(list: readonly EitherAsync<L, R>[]): Promise<R[]>
Takes a list of EitherAsyncs and returns a Promise that will resolve with all Right values. Internally it uses Promise.all to wait for all results
Type Parameters
- L
- R
Parameters
- list: readonly EitherAsync<L, R>[]
Returns Promise<R[]>
- Defined in node_modules/purify-ts/EitherAsync.d.ts:17

sequence

sequence<L, R>(eas: readonly EitherAsync<L, R>[]): EitherAsync<L, R[]>
Turns a list of EitherAsyncs into an EitherAsync of list. The returned Promise will be rejected as soon as a single EitherAsync resolves to a Left, it will not wait for all Promises to resolve and since EitherAsync is lazy, unlike Promise, the remaining async operations will not be executed at all
Type Parameters
- L
- R
Parameters
- eas: readonly EitherAsync<L, R>[]
Returns EitherAsync<L, R[]>
- Defined in node_modules/purify-ts/EitherAsync.d.ts:19

Interface EitherAsyncTypeRef

Type Parameters

Parameters

Returns EitherAsync<L, R>

Index

Methods

Methods

all

Type Parameters

Parameters

Returns EitherAsync<L, R[]>

fromPromise

Type Parameters

Parameters

Returns EitherAsync<L, R>

lefts

Type Parameters

Parameters

Returns Promise<L[]>

liftEither

Type Parameters

Parameters

Returns EitherAsync<L, R>

rights

Type Parameters

Parameters

Returns Promise<R[]>

sequence

Type Parameters

Parameters

Returns EitherAsync<L, R[]>

Settings

On This Page