e3ec7b18b8
* Add the 'awaited' type operator * Add script to manually add reviewers to a PR when GH 'Suggested Reviewers' breaks * Fix lint error in review script * Only defer generic awaited type for possible thenable * Add variance-like behavior for awaited * Switch awaited type params to 'unreliable' variance * fix typo in inferTypes * LKG without syntax in lib * LKG with new syntax in lib * Add 'strictAwaitedTypes' flag * Treat strictAwaitedTypes as strict-mode flag * Rename TAll, remove duplicate definition of 'race' * Apply suggestions from code review Co-Authored-By: ExE Boss <3889017+ExE-Boss@users.noreply.github.com> * Fix inference priority * Update comment to isGenericAwaitableType * Add overloads for then/catch to Promise * Add inference heuristic for T | PromiseLike<T> (for any PromiseLike) * Remove strictAwaitedTypes flag Co-authored-by: ExE Boss <3889017+ExE-Boss@users.noreply.github.com>
153 lines
6.5 KiB
TypeScript
153 lines
6.5 KiB
TypeScript
/*! *****************************************************************************
|
|
Copyright (c) Microsoft Corporation. All rights reserved.
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
|
|
this file except in compliance with the License. You may obtain a copy of the
|
|
License at http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
|
|
WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
|
|
MERCHANTABLITY OR NON-INFRINGEMENT.
|
|
|
|
See the Apache Version 2.0 License for specific language governing permissions
|
|
and limitations under the License.
|
|
***************************************************************************** */
|
|
|
|
|
|
|
|
/// <reference no-default-lib="true"/>
|
|
|
|
|
|
interface PromiseConstructor {
|
|
/**
|
|
* A reference to the prototype.
|
|
*/
|
|
readonly prototype: Promise<any>;
|
|
|
|
/**
|
|
* Creates a new Promise.
|
|
* @param executor A callback used to initialize the promise. This callback is passed two arguments:
|
|
* a resolve callback used to resolve the promise with a value or the result of another promise,
|
|
* and a reject callback used to reject the promise with a provided reason or error.
|
|
*/
|
|
new <T>(executor: (resolve: (value?: T | PromiseLike<T> | awaited T) => void, reject: (reason?: any) => void) => void): Promise<T>;
|
|
|
|
/**
|
|
* Creates a Promise that is resolved with an array of results when all of the provided Promises
|
|
* resolve, or rejected when any Promise is rejected.
|
|
* @param values An array of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
all<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(values: readonly [T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]): Promise<[awaited T1, awaited T2, awaited T3, awaited T4, awaited T5, awaited T6, awaited T7, awaited T8, awaited T9, awaited T10]>;
|
|
|
|
/**
|
|
* Creates a Promise that is resolved with an array of results when all of the provided Promises
|
|
* resolve, or rejected when any Promise is rejected.
|
|
* @param values An array of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
all<T1, T2, T3, T4, T5, T6, T7, T8, T9>(values: readonly [T1, T2, T3, T4, T5, T6, T7, T8, T9]): Promise<[awaited T1, awaited T2, awaited T3, awaited T4, awaited T5, awaited T6, awaited T7, awaited T8, awaited T9]>;
|
|
|
|
/**
|
|
* Creates a Promise that is resolved with an array of results when all of the provided Promises
|
|
* resolve, or rejected when any Promise is rejected.
|
|
* @param values An array of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
all<T1, T2, T3, T4, T5, T6, T7, T8>(values: readonly [T1, T2, T3, T4, T5, T6, T7, T8]): Promise<[awaited T1, awaited T2, awaited T3, awaited T4, awaited T5, awaited T6, awaited T7, awaited T8]>;
|
|
|
|
/**
|
|
* Creates a Promise that is resolved with an array of results when all of the provided Promises
|
|
* resolve, or rejected when any Promise is rejected.
|
|
* @param values An array of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
all<T1, T2, T3, T4, T5, T6, T7>(values: readonly [T1, T2, T3, T4, T5, T6, T7]): Promise<[awaited T1, awaited T2, awaited T3, awaited T4, awaited T5, awaited T6, awaited T7]>;
|
|
|
|
/**
|
|
* Creates a Promise that is resolved with an array of results when all of the provided Promises
|
|
* resolve, or rejected when any Promise is rejected.
|
|
* @param values An array of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
all<T1, T2, T3, T4, T5, T6>(values: readonly [T1, T2, T3, T4, T5, T6]): Promise<[awaited T1, awaited T2, awaited T3, awaited T4, awaited T5, awaited T6]>;
|
|
|
|
/**
|
|
* Creates a Promise that is resolved with an array of results when all of the provided Promises
|
|
* resolve, or rejected when any Promise is rejected.
|
|
* @param values An array of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
all<T1, T2, T3, T4, T5>(values: readonly [T1, T2, T3, T4, T5]): Promise<[awaited T1, awaited T2, awaited T3, awaited T4, awaited T5]>;
|
|
|
|
/**
|
|
* Creates a Promise that is resolved with an array of results when all of the provided Promises
|
|
* resolve, or rejected when any Promise is rejected.
|
|
* @param values An array of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
all<T1, T2, T3, T4>(values: readonly [T1, T2, T3, T4]): Promise<[awaited T1, awaited T2, awaited T3, awaited T4]>;
|
|
|
|
/**
|
|
* Creates a Promise that is resolved with an array of results when all of the provided Promises
|
|
* resolve, or rejected when any Promise is rejected.
|
|
* @param values An array of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
all<T1, T2, T3>(values: readonly [T1, T2, T3]): Promise<[awaited T1, awaited T2, awaited T3]>;
|
|
|
|
/**
|
|
* Creates a Promise that is resolved with an array of results when all of the provided Promises
|
|
* resolve, or rejected when any Promise is rejected.
|
|
* @param values An array of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
all<T1, T2>(values: readonly [T1, T2]): Promise<[awaited T1, awaited T2]>;
|
|
|
|
/**
|
|
* Creates a Promise that is resolved with an array of results when all of the provided Promises
|
|
* resolve, or rejected when any Promise is rejected.
|
|
* @param values An array of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
all<T>(values: readonly T[]): Promise<(awaited T)[]>;
|
|
|
|
/**
|
|
* Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
|
|
* or rejected.
|
|
* @param values An array of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
race<T>(values: readonly T[]): Promise<awaited T>;
|
|
|
|
/**
|
|
* Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
|
|
* or rejected.
|
|
* @param values An iterable of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
race<T>(values: Iterable<T>): Promise<awaited T>;
|
|
|
|
/**
|
|
* Creates a new rejected promise for the provided reason.
|
|
* @param reason The reason the promise was rejected.
|
|
* @returns A new rejected Promise.
|
|
*/
|
|
reject<T = never>(reason?: any): Promise<awaited T>;
|
|
|
|
/**
|
|
* Creates a new resolved promise for the provided value.
|
|
* @param value A promise.
|
|
* @returns A promise whose internal state matches the provided promise.
|
|
*/
|
|
resolve<T>(value: T): Promise<awaited T>;
|
|
|
|
/**
|
|
* Creates a new resolved promise .
|
|
* @returns A resolved promise.
|
|
*/
|
|
resolve(): Promise<void>;
|
|
}
|
|
|
|
declare var Promise: PromiseConstructor;
|