microsoft / microsoft/TypeScript
`ReturnType` and `InstanceType` don't work for functions/constructors with `never` in their parameters
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔎 Search Terms
ReturnType InstanceType any never
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about
ReturnTypeandInstanceType.
⏯ Playground Link
💻 Code
type _1 = ReturnType<(...args: never) => 'foo'>
// ^? type _1 = any
type _2 = InstanceType<new (...args: never) => 'foo'>
// ^? type _2 = any
🙁 Actual behavior
ReturnType and InstanceType always evaluate to any when given a function/constructor whose parameters are ...args: never (or ...args: never[], a: never, b: string, etc).
🙂 Expected behavior
ReturnType and InstanceType should return the actual return/instance type.
Additional information about the issue
Changing the parameter constraint in the conditions of these types from any to never seems to fix the issue:
type ReturnType<T extends (...args: any) => any> = T extends (...args: never) => infer R ? R : any
type InstanceType<T extends abstract new (...args: any) => any> = T extends abstract new (...args: never) => infer R ? R : any
I don't think this will cause any regressions, and did some spot-checking to validate that, but haven't run the entire test suite or anything like that yet.
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
Reproduce the two examples in the linked TypeScript Playground, then locate the declarations of ReturnType and InstanceType and compare their conditional parameter constraints with the proposed never form. Add coverage for functions and constructors with never parameters, and verify that the inferred types are 'foo' rather than any.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 42/100