1 /*! *****************************************************************************
2 Copyright (c) Microsoft Corporation. All rights reserved.
3 Licensed under the Apache License, Version 2.0 (the "License"); you may not use
4 this file except in compliance with the License. You may obtain a copy of the
5 License at http://www.apache.org/licenses/LICENSE-2.0
7 THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
8 KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
9 WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
10 MERCHANTABLITY OR NON-INFRINGEMENT.
12 See the Apache Version 2.0 License for specific language governing permissions
13 and limitations under the License.
14 ***************************************************************************** */
18 /// <reference no-default-lib="true"/>
\r
21 interface PromiseConstructor {
\r
23 * A reference to the prototype.
\r
25 readonly prototype: Promise<any>;
\r
28 * Creates a new Promise.
\r
29 * @param executor A callback used to initialize the promise. This callback is passed two arguments:
\r
30 * a resolve callback used to resolve the promise with a value or the result of another promise,
\r
31 * and a reject callback used to reject the promise with a provided reason or error.
\r
33 new <T>(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void): Promise<T>;
\r
36 * Creates a Promise that is resolved with an array of results when all of the provided Promises
\r
37 * resolve, or rejected when any Promise is rejected.
\r
38 * @param values An array of Promises.
\r
39 * @returns A new Promise.
\r
41 all<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>, T10 | PromiseLike<T10>]): Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>;
\r
44 * Creates a Promise that is resolved with an array of results when all of the provided Promises
\r
45 * resolve, or rejected when any Promise is rejected.
\r
46 * @param values An array of Promises.
\r
47 * @returns A new Promise.
\r
49 all<T1, T2, T3, T4, T5, T6, T7, T8, T9>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>, T9 | PromiseLike<T9>]): Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>;
\r
52 * Creates a Promise that is resolved with an array of results when all of the provided Promises
\r
53 * resolve, or rejected when any Promise is rejected.
\r
54 * @param values An array of Promises.
\r
55 * @returns A new Promise.
\r
57 all<T1, T2, T3, T4, T5, T6, T7, T8>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>, T8 | PromiseLike<T8>]): Promise<[T1, T2, T3, T4, T5, T6, T7, T8]>;
\r
60 * Creates a Promise that is resolved with an array of results when all of the provided Promises
\r
61 * resolve, or rejected when any Promise is rejected.
\r
62 * @param values An array of Promises.
\r
63 * @returns A new Promise.
\r
65 all<T1, T2, T3, T4, T5, T6, T7>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>, T7 | PromiseLike<T7>]): Promise<[T1, T2, T3, T4, T5, T6, T7]>;
\r
68 * Creates a Promise that is resolved with an array of results when all of the provided Promises
\r
69 * resolve, or rejected when any Promise is rejected.
\r
70 * @param values An array of Promises.
\r
71 * @returns A new Promise.
\r
73 all<T1, T2, T3, T4, T5, T6>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>, T6 | PromiseLike<T6>]): Promise<[T1, T2, T3, T4, T5, T6]>;
\r
76 * Creates a Promise that is resolved with an array of results when all of the provided Promises
\r
77 * resolve, or rejected when any Promise is rejected.
\r
78 * @param values An array of Promises.
\r
79 * @returns A new Promise.
\r
81 all<T1, T2, T3, T4, T5>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>, T5 | PromiseLike<T5>]): Promise<[T1, T2, T3, T4, T5]>;
\r
84 * Creates a Promise that is resolved with an array of results when all of the provided Promises
\r
85 * resolve, or rejected when any Promise is rejected.
\r
86 * @param values An array of Promises.
\r
87 * @returns A new Promise.
\r
89 all<T1, T2, T3, T4>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>, T4 | PromiseLike<T4>]): Promise<[T1, T2, T3, T4]>;
\r
92 * Creates a Promise that is resolved with an array of results when all of the provided Promises
\r
93 * resolve, or rejected when any Promise is rejected.
\r
94 * @param values An array of Promises.
\r
95 * @returns A new Promise.
\r
97 all<T1, T2, T3>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>, T3 | PromiseLike<T3>]): Promise<[T1, T2, T3]>;
\r
100 * Creates a Promise that is resolved with an array of results when all of the provided Promises
\r
101 * resolve, or rejected when any Promise is rejected.
\r
102 * @param values An array of Promises.
\r
103 * @returns A new Promise.
\r
105 all<T1, T2>(values: readonly [T1 | PromiseLike<T1>, T2 | PromiseLike<T2>]): Promise<[T1, T2]>;
\r
108 * Creates a Promise that is resolved with an array of results when all of the provided Promises
\r
109 * resolve, or rejected when any Promise is rejected.
\r
110 * @param values An array of Promises.
\r
111 * @returns A new Promise.
\r
113 all<T>(values: readonly (T | PromiseLike<T>)[]): Promise<T[]>;
\r
115 // see: lib.es2015.iterable.d.ts
\r
116 // all<T>(values: Iterable<T | PromiseLike<T>>): Promise<T[]>;
\r
119 * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
\r
121 * @param values An array of Promises.
\r
122 * @returns A new Promise.
\r
124 race<T>(values: readonly T[]): Promise<T extends PromiseLike<infer U> ? U : T>;
\r
126 // see: lib.es2015.iterable.d.ts
\r
127 // race<T>(values: Iterable<T>): Promise<T extends PromiseLike<infer U> ? U : T>;
\r
130 * Creates a new rejected promise for the provided reason.
\r
131 * @param reason The reason the promise was rejected.
\r
132 * @returns A new rejected Promise.
\r
134 reject<T = never>(reason?: any): Promise<T>;
\r
137 * Creates a new resolved promise.
\r
138 * @returns A resolved promise.
\r
140 resolve(): Promise<void>;
\r
143 * Creates a new resolved promise for the provided value.
\r
144 * @param value A promise.
\r
145 * @returns A promise whose internal state matches the provided promise.
\r
147 resolve<T>(value: T | PromiseLike<T>): Promise<T>;
\r
150 declare var Promise: PromiseConstructor;
\r