Promise<T>

package js.lib

Available on js

The Promise object represents the eventual completion (or failure) of an asynchronous operation and its resulting value.

Documentation Promise by Mozilla Contributors, licensed under CC-BY-SA 2.5.

Static methods

staticall(iterable:Array<Dynamic>):Promise<Array<Dynamic>>

Returns a promise that either fulfills when all of the promises in the iterable argument have fulfilled or rejects as soon as one of the promises in the iterable argument rejects. If the returned promise fulfills, it is fulfilled with an array of the values from the fulfilled promises in the same order as defined in the iterable. If the returned promise rejects, it is rejected with the reason from the first promise in the iterable that rejected. This method can be useful for aggregating results of multiple promises.

staticrace(iterable:Array<Dynamic>):Promise<Dynamic>

Returns a promise that fulfills or rejects as soon as one of the promises in the iterable fulfills or rejects, with the value or reason from that promise.

staticreject<T>(?reason:Dynamic):Promise<T>

Returns a Promise object that is rejected with the given reason.

staticresolve<T>(thenable:Thenable<T>):Promise<T>

staticresolve<T>(?value:T):Promise<T>

Returns a Promise object that is resolved with the given value. If the value is Thenable, the returned promise will "follow" that thenable, adopting its eventual state; otherwise the returned promise will be fulfilled with the value. Generally, when it's unknown when value is a promise or not, use Promise.resolve(value) instead and work with the return value as a promise.

Constructor

new(init:(resolve:(value:T) ‑> Void, reject:(reason:Dynamic) ‑> Void) ‑> Void)

Throws:

null	DOMError

Methods

catchError<TOut>(onRejected:PromiseHandler<Dynamic, TOut>):Promise<TOut>

Appends a rejection handler callback to the promise, and returns a new promise resolving to the return value of the callback if it is called, or to its original fulfillment value if the promise is instead fulfilled.

then<TOut>(onFulfilled:Null<PromiseHandler<T, TOut>>, ?onRejected:PromiseHandler<Dynamic, TOut>):Promise<TOut>

Appends fulfillment and rejection handlers to the promise and returns a new promise resolving to the return value of the called handler, or to its original settled value if the promise was not handled (i.e. if the relevant handler onFulfilled or onRejected is not a function).