TypeScript 转 JSDoc

将使用 JSDoc 注释的 TypeScript 代码转换为完全兼容的 JavaScript 代码, 同时保留您的文档注释。

使用方法

命令行

$ ts-to-jsdoc

用法:
  ts-to-jsdoc [options] <path>...
  ts-to-jsdoc -p path/to/tsconfig.json

选项:
  -h --help          显示帮助信息。
  -p --project       tsconfig.json 的路径。
  -o --out --output  输出转换后的 JavaScript 文件的目录。[默认: 源文件路径, 如果设置了 project 则忽略此项]
  -i --ignore        转换时要忽略的文件或目录路径。[如果设置了 project 则忽略此项]
  -f --force         覆盖现有的输出文件。[如果设置了 project 则忽略此项]

Node.js

const { transpileFile, transpileProject } = require("ts-to-jsdoc");
// 或者
import { transpileFile, transpileProject } from "ts-to-jsdoc";

const code = `
/**
 * 执行某些操作.
 * @param param 这是一个参数。
 */
function doStuff(param: string): number { }
`;

const transpiledCode = transpileFile({ code: code });
// 输出:
// /**
//  * 执行某些操作.
//  * @param {string} param 这是一个参数。
//  * @returns {number}
//  */
// function doStuff(param) { }

/* 或者您可以一次转换整个项目 */
transpileProject({ project: "path/to/tsconfig.json" });

许可证

MIT © futurGH.