microsoft / microsoft/TypeScript
jsdoc @type is not working properly for some class method variant
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: 4.0.0-beta and 3.9.2
Search Terms: jsdoc, type, typedef, class method, typechecking
Code
// @strict: false
/**
* @typedef {(newNumber: number) => void} SetNumberFunc
*/
class A {
/**
* @type {number}
*/
a = 0;
constructor() {
this.a = 0;
}
/**
* @type {SetNumberFunc}
*/
setAVariant1(newNumber) {
this.a = newNumber;
}
}
Expected behavior: The newNumber param should have a number type when hovering on the setAVariant1 method.
Actual behavior: The newNumber param have any type when hovering on the setAVariant1 method.
Playground Link: Playground Link
Related Issues: -
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 with the linked TypeScript Playground reproduction and inspect how the JSDoc @type annotation is handled for the class method setAVariant1. Compare the hover type of newNumber with the expected number type, and verify that the reproduction reports number rather than any when the fix is complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100