microsoft / microsoft/TypeScript

Overloaded function args not inferred correctly

Open
#54,539 7 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: check: Type Inference Help Wanted Possible Improvement
Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

Bug Report

🔎 Search Terms

overload functions

🕗 Version & Regression Information
  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about overloading and different function arguments behavior
⏯ Playground Link

Playground link with relevant code

💻 Code
function a1(arg1: unknown): 1;
function a1(arg1: unknown, arg2: unknown): 2;
function a1(...args: ([arg1: unknown] | [arg1: unknown, arg2: unknown])): 1 | 2 {
    return args.length;
}

const b1: typeof a1 = function f1(...args) {
    return a1(...args);
}

even simpler is using an interface

interface a1 {
    (arg1: unknown): 1;
    (arg1: unknown, arg2: unknown): 2;
}

// errors
const b1: a1 = function f1(...args) {
    return args.length;
}
🙁 Actual behavior

Error: Target signature provides too few arguments. Expected 2 or more, but got one., given the single signature of b1 above is variadic, and in fact matches the implementation signature of a1, one would assume the two functions are equivalent (from a signature perspective)

🙂 Expected behavior

The type of args in b1 should be inferred as the union of all overloads of a1 since it is the only way the variadic args would satisfy the assigned typeof a1 requirement.

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 with the linked TypeScript Playground and the two overload examples to reproduce the diagnostic. Trace how the assigned function's rest parameter is inferred against the overloads, then verify that args receives the required overload union and the assignment is accepted without the reported error.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.