microsoft / microsoft/TypeScript

Function implementation that returns literal types is not assignable to widened overload

Open
#37,394 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Bug Domain: Literal Types
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.

Playground Link

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.