microsoft / microsoft/TypeScript
Use any instead of unknown for AsyncGenerator optional .next parameter
@rbuckton is already working on this.
Since Sep 17, 2019.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: 3.6.2
Search Terms:
async generator, AsyncGenerator, optional .next
Code
The following causes a type error:
async function* sequence(iterable: AsyncIterable<number>): AsyncGenerator<number> {
yield 12;
try {
// Type error: Cannot delegate iteration to value because the 'next' method of its iterator expects type 'undefined', but the containing generator will always send 'unknown'.
yield* iterable;
} finally {
console.log('Cleanup!');
}
}
Expected behavior:
I would've expected it to be a non-type error.
Problem:
The primary annoyance with this is that I'd like to use AsyncGenerator<T> just for specifying that .return() can be used without non-null assertions (.return!()) for early cleanup but AsyncGenerator<T> results in AsyncGenerator<T, any, unknown> so AsyncIterable<T> can't be delegated to.
Proposed solution:
Change interface AsyncGenerator<T = unknown, TReturn = any, TNext = unknown> to interface AsyncGenerator<T = unknown, TReturn = any, TNext = any.
This won't break anything as any is assignable to anything, and I doubt it'll be problematic as those using AsyncGenerator<T> (or AsyncGenerator<T, S>) presumably do not care about the .next parameter.
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.