microsoft / microsoft/TypeScript
Class generics not evaluated properly in JSDoc
@sandersn is already working on this.
Since Dec 5, 2023.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔎 Search Terms
jsdoc generics
🕗 Version & Regression Information
This is the behavior in every version I tried (i.e. at random from 3.6.3 to nightly), and I reviewed the FAQ for entries about jsdoc and generics
⏯ Playground Link
💻 Code
(not working): TypeScript in JSDoc (playground link)
/** @template T */
class Dom {
/** @type {Object<string, T>} */
nodesById = {};
getChildren() {return this.nodesById}
}
/** @type {Dom<number>} */
const node = new Dom();
const children = node.getChildren(); // type is {[id: string]: T}
(working): TypeScript (playground link)
class Dom<T> {
nodesById: {[id: string]: T} = {};
getChildren() {return this.nodesById}
}
const node = new Dom<number>();
const children = node.getChildren(); // type is {[id: string]: number}
🙁 Actual behavior
With TypeScript in JSDoc, children has the type {[id: string]: T}, i.e. T is not resolved, although node has the type Dom<number>.
🙂 Expected behavior
With TypeScript, children has the type {[id: string]: number}, i.e. T is taken correctly from Dom<number>. The same is expected for TypeScript in JSDoc.
Additional information about the issue
Obviously, this is just a minimal working example. We have a large legacy codebase where we introduce TypeScript gradually via JSDoc comments (a nuke-everything TypeScript rewrite would not be feasible).
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.
Assessment
This issue has not been assessed yet.