在 Typescript 中使用 JSDoc 中定义的接口

Question

我正在尝试使用 allowJs 和 checkJs 在 JS 代码库上设置 TypeScript

I have a JSDoc that uses an interface as a parameter type:

 * @param {IPlugin[]|IPlugin} plugins plugin instance(s).

In the same file，我有通过JSDoc定义的接口：

/**
 * Plugin extension hooks.
 * @interface IPlugin
 * @since 2.1.0
 */

This looks like valid JSDoc to me。但是，TypeScript 失败了：

src/core/core.plugins.js:243:13 - 错误 TS2304：找不到名称“IPlugin”。

243 * @param {IPlugin[]|IPlugin} 插件插件实例。

有什么想法可以让它发挥作用吗？

Answer 1

Typescript 不支持@interface：https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html#supported-jsdoc

建议使用d.ts文件代替：https://github.com/microsoft/TypeScript/issues/33207#issuecomment-527680208

也可以使用@typedef: https://github.com/AlCalzone/ioBroker.js-controller/blob/9fbbb890290b07af5d9dfb7ae90bf92f2d0be178/lib/tools.js#L1329 破解它