使用TypeScript创建库:如何直接导出.ts中函数避免.d.ts重复声明
解决方案
你不需要手动编写重复的.d.ts声明,直接通过TypeScript自带的自动生成类型声明功能即可实现需求,操作步骤如下:
- 配置tsconfig.json开启自动生成声明文件
在项目的tsconfig.json中开启declaration配置项,编译时TS会自动根据你写的.ts源码生成完全匹配的.d.ts文件,无需手动编写任何重复类型:
{ "compilerOptions": { // 其余原有配置保持不变 "declaration": true, // 开启自动生成.d.ts声明文件 "declarationMap": true, // 可选配置,生成类型映射文件,方便IDE跳转到源码定义 "outDir": "./dist" // 编译产物输出目录,生成的.js和.d.ts都会放在这个目录下 }, "include": ["src/**/*"], // 确认包含你的所有源码文件 "exclude": ["node_modules", "dist"] }
- 配置package.json让IDE识别类型入口
如果你开发的是对外发布的第三方库,需要在package.json中指定类型文件的入口,IDE就可以正常识别导出项、给出自动提示:
{ "name": "你的包名", "version": "1.0.0", "main": "./dist/index.js", // 编译后JS的入口文件 "types": "./dist/index.d.ts" // 自动生成的声明文件入口 }
- 本地项目无导入提示的排查项
如果是本地项目内部导入没有提示,优先检查两点:
- 确认
tsconfig.json的include配置包含了你存放TS源码的目录 - 确认没有在
exclude配置中误排除了你的源码文件
补充:如果你不需要将代码编译为JS发布,希望直接导出TS源码供使用方导入,无需额外生成.d.ts,只要确保使用方的TS配置包含你的TS源码文件即可。不过自动生成.d.ts的方案兼容性更强、IDE加载类型的速度更快,更推荐生产场景使用。
内容的提问来源于stack exchange,提问作者David Min
相关产品推荐
相关产品推荐

