Class PromiseCollection<T>

A Promise collection exposes useful methods for handling a collection of promises and their results.

Type Parameters

T

Hierarchy

default
- PromiseCollection

Index

Constructors

Accessors

Methods

_onDispose all map pipe race reduce waitAll

Constructors

constructor

new PromiseCollection<T>(
source: undefined | null | PromiseLike<T>[],
): PromiseCollection<T>
Type Parameters
- T
Parameters
- source: undefined | null | PromiseLike<T>[]
Returns PromiseCollection<T>
Overrides DisposableBase.constructor
- Defined in Promise.ts:894

Accessors

promises

get promises(): PromiseLike<T>[]
Returns a copy of the source promises.

Returns PromiseLike<T>[]
- Defined in Promise.ts:904

Methods

`Protected`_onDispose

_onDispose(): void
Returns void
Overrides DisposableBase._onDispose
- Defined in Promise.ts:1019

all

all(): ArrayPromise<T>
Returns a promise that is fulfilled with an array containing the fulfillment value of each promise, or is rejected with the same rejection reason as the first promise to be rejected.

Returns ArrayPromise<T>
- Defined in Promise.ts:914

map

map<U>(transform: (value: T) => U): ArrayPromise<U>
Waits for all the values to resolve and then applies a transform.
Type Parameters
- U
Parameters
- transform: (value: T) => U
Returns ArrayPromise<U>
- Defined in Promise.ts:947

pipe

pipe<U>(transform: (value: T) => U | PromiseLike<U>): PromiseCollection<U>
Applies a transform to each promise and defers the result. Unlike map, this doesn't wait for all promises to resolve, ultimately improving the async nature of the request.
Type Parameters
- U
Parameters
- transform: (value: T) => U | PromiseLike<U>
Returns PromiseCollection<U>
- Defined in Promise.ts:962

race

race(): PromiseBase<T>
Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

Returns PromiseBase<T>
A new Promise.
- Defined in Promise.ts:925

reduce

reduce(
    reduction: (
        previousValue: T,
        currentValue: T,
        i?: number,
        array?: PromiseLike<T>[],
    ) => T,
    initialValue?: T | PromiseLike<T>,
): PromiseBase<T>
Behaves like array reduce. Creates the promise chain necessary to produce the desired result.
Parameters
- reduction: (previousValue: T, currentValue: T, i?: number, array?: PromiseLike<T>[]) => T
- OptionalinitialValue: T | PromiseLike<T>
Returns PromiseBase<T>
- Defined in Promise.ts:977
reduce<U>(
    reduction: (
        previousValue: U,
        currentValue: T,
        i?: number,
        array?: PromiseLike<T>[],
    ) => U,
    initialValue: U | PromiseLike<U>,
): PromiseBase<U>
Behaves like array reduce. Creates the promise chain necessary to produce the desired result.
Type Parameters
- U
Parameters
- reduction: (previousValue: U, currentValue: T, i?: number, array?: PromiseLike<T>[]) => U
- initialValue: U | PromiseLike<U>
Returns PromiseBase<U>
- Defined in Promise.ts:988

waitAll

waitAll(): ArrayPromise<PromiseLike<T>>
Returns a promise that is fulfilled with array of provided promises when all provided promises have resolved (fulfill or reject). Unlike .all this method waits for all rejections as well as fulfillment.

Returns ArrayPromise<PromiseLike<T>>
- Defined in Promise.ts:936