如何解决使用jsdoc生成打字稿时找不到命名空间
我有一个很大的旧 javascript 库,它用 jsdoc 进行了彻底的注释,并生成了看起来不错的 API 文档。我想使用打字稿编译器基于此制作打字稿模板文件。但是,tsc
失败并显示 error TS2503
,因为我们记录类的方式(代码的核心早于 ES6,因此它不使用 class
关键字)。下面给出了一个简单的复制示例:
文件src/index.js
/**
* @namespace sample
*/
module.exports = {
aclass: require('./aclass')
};
文件src/aclass.js
/**
* @class
* @alias sample.aclass
* @returns {sample.aclass} A instance of the aclass.
*/
var aclass = function () {
if (!(this instanceof aclass)) {
return new aclass();
}
};
module.exports = {
aclass: aclass
};
文件tsconfig.json
{
"include": ["src/index.js"],"compilerOptions": {
"allowJs": true,"checkJs": true,"declaration": true,"outDir": "dist/ts","target": "es6","module": "CommonJS","lib": ["es6","dom"],"noEmit": true,"strict": false,"noImplicitThis": true,"alwaysStrict": true,"esModuleInterop": true
}
}
运行tsc
时,专门输出
src/aclass.js:4:14 - error TS2503: Cannot find namespace 'sample'.
4 * @returns {sample.aclass} A instance of the aclass.
理想情况下,我仍然希望生成好的 jsdoc 并生成打字稿模板文件。如何重构 jsdoc 或更改 tsconfig 以使其工作?
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。