如何导出将发布到 npm 的 JavaScript 库的 JSDoc 类型

How to export JSDoc types for a JavaScript library that will be published to npm

提问人:Battal 提问时间:11/17/2023 最后编辑:Battal 更新时间:11/17/2023 访问量:35

问:

我已经在网上搜索了这个,甚至在 GitHub 上查看了 TypeScript 问题(5k+ 问题),但似乎可以找到一种方法;例;

// my-module/tsconfig.json
{
  "compilerOptions": {
    "noEmit": true,
    "moduleResolution": "Node",
    "esModuleInterop": true,
    "target": "ESNext",

    "allowJs": true,
    "checkJs": true
  },
  "include": ["index.js"]
}
// my-module/index.js

/** @typedef {{ name: string, surname: string, age: number }} User */
/**
 *
 * @param {string} name
 * @param {string} surname
 * @param {number} age
 * @returns {User}
 */
const NewUser = (name, surname, age) => {
  return { name, surname, age };
};
export default NewUser;
// app.js

import NewUser from "my-module"
Could not find a declaration file for module 'my-module', 'node_modules/my-module/index.js' implicitly has an 'any' type.ts(7016)

如果我运行 TypeScript 编译器并生成d.ts文件,但我不想到处都有编译器步骤和不必要的文件,我想使用 JSDoc 直接从 JS 文件导出类型。可能吗?

打字稿 jsdoc

评论

0赞 jsejcksn 11/19/2023
你能编辑问题以包括一个最小的可重复的例子吗?软件包和使用软件包中所有文件的内容以及重现错误的步骤、软件版本等都是必需的。请参阅如何提问"my-module"

答: 暂无答案