microsoft / microsoft/TypeScript
Function implementation that returns literal types is not assignable to widened overload
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: 3.8.3
Search Terms: overload widen literal
Code
function foo(x: string): string;
function foo(x: number): number;
function foo(x: string | number) {
if (typeof x === 'string') return 'foo';
return 23;
}
Expected behavior: Implementation satisfies overloads.
Actual behavior: The first overload throws an error that it doesn't match the implementation. Doesn't matter which overload comes first.
If I widen the literals in the implementation by casting them then everything works fine.
Related Issues: https://github.com/microsoft/TypeScript/issues/37393
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.
Research direction
Start by reproducing the overload example in the linked TypeScript Playground and compare it with the version using widened literal casts. Trace the implementation-compatibility check for overloads; done means the shown implementation satisfies both overloads without casts, with coverage for this regression.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100