microsoft / microsoft/TypeScript
Generators with extended unions, null and undefined produces compiler errors
@rbuckton is already working on this.
Since Sep 3, 2020.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
I've run into a weird problem in a project that uses async generators. I've reduced the problematic code to the example
below, which also fails in a similar way that my actual code does.
There seem to be several conditions that must be fulfilled:
- Type
Tis a union. - The argument generator extends
T(withWithIDin the example). - The argument generator also accepts both
nullandundefiened. - The provided generator has a return signature.
- The provided generator's return signature yields
Tand eithernullorundefined(but not both).
Change just any of these conditions in the playground, and the error goes away ...
TypeScript Version: 4.0.0-beta (and below)
Search Terms: generator null undefined
Expected behavior: No errors.
Actual behavior: A strange error message when doSomething() is called.
Related Issues: No
Code
interface WithID {
id?: number;
}
type MyEvent = { type: "number", value: number } | { type: "string", value: string };
//interface MyEvent { type: "number" | "string", value: number | string };
function doSomething<T extends object>(gen: Generator<T & WithID | undefined | null>) {
// ...
}
function* readEvents(): Generator<MyEvent | undefined> {
yield undefined;
}
doSomething(readEvents());
Output
"use strict";
//interface MyEvent { type: "number" | "string", value: number | string };
function doSomething(gen) {
// ...
}
function* readEvents() {
yield undefined;
}
doSomething(readEvents());
Compiler Options
{
"compilerOptions": {
"noImplicitAny": true,
"strictNullChecks": true,
"strictFunctionTypes": true,
"strictPropertyInitialization": true,
"strictBindCallApply": true,
"noImplicitThis": true,
"noImplicitReturns": true,
"alwaysStrict": true,
"esModuleInterop": true,
"declaration": true,
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"moduleResolution": 2,
"target": "ES2019",
"jsx": "React",
"module": "ESNext"
}
}
Playground Link: Provided
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.