Skip to content

Commit 6e30675

Browse files
rbucktonrbuckton
committed
Revert default behavior to allow custom Promise return types for async functions.
1 parent 06d62ed commit 6e30675

45 files changed

Lines changed: 193 additions & 134 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/compiler/checker.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12623,7 +12623,7 @@ namespace ts {
1262312623
* callable `then` signature.
1262412624
*/
1262512625
function checkAsyncFunctionReturnType(node: FunctionLikeDeclaration): Type {
12626-
if (languageVersion >= ScriptTarget.ES6) {
12626+
if (compilerOptions.noCustomAsyncPromise && languageVersion >= ScriptTarget.ES6) {
1262712627
const returnType = getTypeFromTypeNode(node.type);
1262812628
return checkCorrectPromiseType(returnType, node.type);
1262912629
}
@@ -13029,6 +13029,10 @@ namespace ts {
1302913029
}
1303013030

1303113031
function checkCollisionWithGlobalPromiseInGeneratedCode(node: Node, name: Identifier): void {
13032+
if (!compilerOptions.noCustomAsyncPromise) {
13033+
return;
13034+
}
13035+
1303213036
if (!needCollisionCheckForIdentifier(node, name, "Promise")) {
1303313037
return;
1303413038
}

‎src/compiler/commandLineParser.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,11 @@ namespace ts {
299299
name: "noImplicitUseStrict",
300300
type: "boolean",
301301
description: Diagnostics.Do_not_emit_use_strict_directives_in_module_output
302+
},
303+
{
304+
name: "noCustomAsyncPromise",
305+
type: "boolean",
306+
experimental: true
302307
}
303308
];
304309

‎src/compiler/emitter.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -296,21 +296,21 @@ namespace ts {
296296
* If loop contains block scoped binding captured in some function then loop body is converted to a function.
297297
* Lexical bindings declared in loop initializer will be passed into the loop body function as parameters,
298298
* however if this binding is modified inside the body - this new value should be propagated back to the original binding.
299-
* This is done by declaring new variable (out parameter holder) outside of the loop for every binding that is reassigned inside the body.
299+
* This is done by declaring new variable (out parameter holder) outside of the loop for every binding that is reassigned inside the body.
300300
* On every iteration this variable is initialized with value of corresponding binding.
301301
* At every point where control flow leaves the loop either explicitly (break/continue) or implicitly (at the end of loop body)
302302
* we copy the value inside the loop to the out parameter holder.
303-
*
303+
*
304304
* for (let x;;) {
305305
* let a = 1;
306306
* let b = () => a;
307307
* x++
308308
* if (...) break;
309309
* ...
310310
* }
311-
*
311+
*
312312
* will be converted to
313-
*
313+
*
314314
* var out_x;
315315
* var loop = function(x) {
316316
* var a = 1;
@@ -326,7 +326,7 @@ namespace ts {
326326
* x = out_x;
327327
* if (state === "break") break;
328328
* }
329-
*
329+
*
330330
* NOTE: values to out parameters are not copies if loop is abrupted with 'return' - in this case this will end the entire enclosing function
331331
* so nobody can observe this new value.
332332
*/
@@ -3049,7 +3049,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
30493049
}
30503050

30513051
writeLine();
3052-
// end of loop body -> copy out parameter
3052+
// end of loop body -> copy out parameter
30533053
copyLoopOutParameters(convertedLoopState, CopyDirection.ToOutParameter, /*emitAsStatements*/true);
30543054

30553055
decreaseIndent();
@@ -4685,7 +4685,7 @@ const _super = (function (geti, seti) {
46854685
write(", void 0, ");
46864686
}
46874687

4688-
if (languageVersion >= ScriptTarget.ES6 || !promiseConstructor) {
4688+
if (!promiseConstructor || (compilerOptions.noCustomAsyncPromise && languageVersion >= ScriptTarget.ES6)) {
46894689
write("void 0");
46904690
}
46914691
else {
@@ -7245,7 +7245,7 @@ const _super = (function (geti, seti) {
72457245
}
72467246

72477247
// text should be quoted string
7248-
// for deduplication purposes in key remove leading and trailing quotes so 'a' and "a" will be considered the same
7248+
// for deduplication purposes in key remove leading and trailing quotes so 'a' and "a" will be considered the same
72497249
const key = text.substr(1, text.length - 2);
72507250

72517251
if (hasProperty(groupIndices, key)) {

‎src/compiler/types.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2442,6 +2442,8 @@ namespace ts {
24422442
/* @internal */ skipDefaultLibCheck?: boolean;
24432443
// Do not perform validation of output file name in transpile scenarios
24442444
/* @internal */ suppressOutputPathCheck?: boolean;
2445+
// Disallow custom promise return types in async functions.
2446+
/* @internal */ noCustomAsyncPromise?: boolean;
24452447

24462448
[option: string]: string | number | boolean;
24472449
}

‎tests/baselines/reference/asyncAliasReturnType_es6.errors.txt‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
tests/cases/conformance/async/es6/asyncAliasReturnType_es6.ts(3,16): error TS1055: Type 'PromiseAlias' is not a valid async function return type.
2+
3+
4+
==== tests/cases/conformance/async/es6/asyncAliasReturnType_es6.ts (1 errors) ====
5+
type PromiseAlias<T> = Promise<T>;
6+
7+
async function f(): PromiseAlias<void> {
8+
~
9+
!!! error TS1055: Type 'PromiseAlias' is not a valid async function return type.
10+
}

‎tests/baselines/reference/asyncAliasReturnType_es6.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ async function f(): PromiseAlias<void> {
66

77
//// [asyncAliasReturnType_es6.js]
88
function f() {
9-
return __awaiter(this, void 0, void 0, function* () {
9+
return __awaiter(this, void 0, PromiseAlias, function* () {
1010
});
1111
}

‎tests/baselines/reference/asyncAliasReturnType_es6.symbols‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎tests/baselines/reference/asyncAliasReturnType_es6.types‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎tests/baselines/reference/asyncArrowFunction1_es6.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ var foo = async (): Promise<void> => {
44
};
55

66
//// [asyncArrowFunction1_es6.js]
7-
var foo = () => __awaiter(this, void 0, void 0, function* () {
7+
var foo = () => __awaiter(this, void 0, Promise, function* () {
88
});

‎tests/baselines/reference/asyncArrowFunction6_es6.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ var foo = async (a = await): Promise<void> => {
44
}
55

66
//// [asyncArrowFunction6_es6.js]
7-
var foo = (a = yield ) => __awaiter(this, void 0, void 0, function* () {
7+
var foo = (a = yield ) => __awaiter(this, void 0, Promise, function* () {
88
});

0 commit comments

Comments
 (0)