microsoft / microsoft/TypeScript
Combining jsdoc `@this` and `@param` yields invalid `.d.ts` file
Open
@sandersn is already working on this.
Since Aug 2, 2023.
Needs Investigation
Rescheduled
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
Bug Report
When combining the JSDoc tags @this and @param, TypeScript yields invalid type definitions.
🔎 Search Terms
jsdoc this constructor
🕗 Version & Regression Information
- Behaviour was wrong in 4.5.
- Behaviour changed in 4.6, but is also wrong. This behaviour still exists in 5.2.0-dev.20230729.
⏯ Playground Link
Playground link with relevant code
💻 Code
/**
* @typedef Person
* @property {string} name
*/
/**
* @this {Person}
* @param {string} name
*/
export default function fn(name) {
this.name = name
}
🙁 Actual behavior
/**
* @typedef Person
* @property {string} name
*/
/**
* @this {Person}
* @param {string} name
*/
export default function fn(this: Person, name: string): void;
export default class fn {
/**
* @typedef Person
* @property {string} name
*/
/**
* @this {Person}
* @param {string} name
*/
constructor(this: Person, name: string);
// ^^^^^^^^^^^^ This is not valid TypeScript
name: string;
}
export type Person = {
name: string;
};
TypeScript 4.5 and before (also wrong):
/**
* @typedef Person
* @property {string} name
*/
/**
* @this {Person}
* @param {string} name
*/
export default function fn(name: string): void;
// ^^ Missing this
export default class fn {
/**
* @typedef Person
* @property {string} name
*/
/**
* @this {Person}
* @param {string} name
*/
constructor(name: string);
name: string;
}
export type Person = {
name: string;
};
🙂 Expected behavior
I would expect the class to not be generated. The generated class definition is the part that is invalid, and also if this function was written in TypeScript, the class would not be generated.
/**
* @typedef Person
* @property {string} name
*/
/**
* @this {Person}
* @param {string} name
*/
export default function fn(this: Person, name: string): void;
export type Person = {
name: string;
};
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.