使用 JsDoc 转换打字稿

עתו*_*אית 10 javascript jsdoc typescript tsc tsdoc

我可以使用 JSDoc 将 TypeScript 文件转换为 JavaScript 文件吗?
例如,如果我有这个main.ts文件:

let x: string = "hello";
// This could be number or array of numbers
let y: number | number[];
Run Code Online (Sandbox Code Playgroud)

它将被转换为类似这样的main.js文件:

/**
 * @type {string}
 */
let x = "hello";
/**
 * This could be number or array of numbers
 * @type {number | number[]}
 */
let y;
Run Code Online (Sandbox Code Playgroud)

等等。
有没有办法做到这一点?
谢谢!

fut*_*tur 11

虽然这样的功能超出了 TypeScript 的范围,但可以利用它提供的 Compiler API 来解释类型并将其转换为 JSDoc 文档。您可以在TypeScript GitHub 存储库中找到有关编译器 API 的文档。

(或者,您可以使用 NPM 包ts-to-jsdoc来为您处理这项工作!)

免责声明:我写了 ts-to-jsdoc。您可以在 MIT 许可证下在https://github.com/futurGH/ts-to-jsdoc找到源代码。

  • 您能详细说明一下“有充分理由”吗? (4认同)

Vas*_*cek 0

根据这个工具的描述,它可能对您有用,因为它似乎完全满足您的需要,即将 TypeScript 转换为带有 JSDoc 注释的纯 ES 代码 - 看看这里:

https://github.com/SoftwareBrothers/better-docs#examples