microsoft / microsoft/TypeScript
Why do we need to manually type unified overload signatures?
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Please close if this has been asked before - nothing came up when searching.
Search Terms
overload, function, multiple, default, combine, unify, top
Suggestion
Today, when defining an overloaded call signature you have to manually type the implementation. Would it be possible to extend contextual types so TS can infer the implementation's types from context, just like TS already does for non-overloaded signatures?
Use Cases
Today, contextual typing isn't able to infer parameter types for overloaded call signatures. Instead, users have to manually type the implementation.
Examples
Before
type Reserve = {
(from: Date, to: Date, destination: string): Reservation
(from: Date, destination: string): Reservation
}
let reserve: Reserve = (
from: Date,
toOrDestination: Date | string,
destination?: string
) => { /* ... */ }
After
type Reserve = {
(from: Date, to: Date, destination: string): Reservation
(from: Date, destination: string): Reservation
}
let reserve: Reserve = (
from, // inferred as Date | Date = Date
toOrDestination, // inferred as Date | string
destination // inferred as string | undefined
) => { /* ... */ }
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript / JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. new expression-level syntax)
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 studying TypeScript's contextual typing and overload-signature behavior, using the examples in the issue as the behavioral reference. Determine how parameter types should be combined across overloads and add coverage for the shown Reserve assignment. Done means compatible overloaded implementations receive inferred parameter types without changing runtime output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100