让自己的npm包拥有typescript类型支持

简介: 让自己的npm包拥有typescript类型支持

目录


前言


别人使用我们发布的 npm 包时,可能不知道对应的参数,与对应的类型。

如何让我们的包拥有类型支持呢,使用 typescript 生成 d.ts 文件即可,我们来试试。

创建项目


$ mkdir project && cd project 
$ npm init -y

全局安装typescript


$ npm i typescript -g

使用typescript格式化项目


项目根目录执行。

$ npx tsc --init

会发现多出一个文件 tsconfig.json 。

image.png

我们修改对应的设置,添加设置"declaration": true,可以帮助我们编译 ts 文件自动额外生成 d.ts文件。

我这里还顺便加上了 "declarationMap": true,用于生成 d.ts.map 文件,你可以根据需要添加。

"declaration": true,       
"declarationMap": true, 


image.png


编写 index.ts 文件,我们要确保自己编写ts文件内容时严谨的控制自己的变量类型,这样自动生成的 d.ts 才有作用。

编译 ts


然后我们在项目根目录运行 tsc 开始编译。

$ tsc

会发现生成了对应的我们需要的 d.ts 文件

image.png

兼容性处理


要注意通过 ts 编译生成的 js 文件并没有做好兼容处理,我们上传npm包之前可能还需要对其进行es6到es5的兼容性处理。


详见另一篇文章:nodejs ES6模块使用 以及 ES6代码转ES5兼容性处理。


推荐使用文章第二种方案,esbuild 相比 babel 比较简单且更快。


定义类型文件位置


记得在 package.json 中指明 d.ts 类型文件位置,否则该文件无法生效:

  "types": [
    "lib/index.d.ts"
  ],

image.png

尾言


做完以上步骤,就可以把我们的项目上传至npm仓库啦。

如果觉得文章对你有帮助的话,欢迎点赞收藏哦,有什么错误或者意见建议也可以留言,感谢~

相关文章
|
1月前
|
前端开发 小程序 API
【微信小程序】-- 使用 npm 包 - API Promise化(四十二)
【微信小程序】-- 使用 npm 包 - API Promise化(四十二)
|
1月前
|
资源调度 小程序 前端开发
【微信小程序】-- 使用 npm 包 - Vant Weapp(四十一)
【微信小程序】-- 使用 npm 包 - Vant Weapp(四十一)
|
2月前
|
JavaScript 前端开发 安全
Apollo与TypeScript:强大类型检查在前端开发中的应用
Apollo与TypeScript:强大类型检查在前端开发中的应用
|
1月前
|
资源调度 小程序 前端开发
【微信小程序】-- npm包总结 --- 基础篇完结(四十七)
【微信小程序】-- npm包总结 --- 基础篇完结(四十七)
|
3月前
|
资源调度
#发布npm包遇到错误,因为用了淘宝镜像地址的原因的解决方法-403 403 Forbidden - PUT https://registry.npmmirror.com/-/user/org.cou
#发布npm包遇到错误,因为用了淘宝镜像地址的原因的解决方法-403 403 Forbidden - PUT https://registry.npmmirror.com/-/user/org.cou
163 0
|
2天前
|
JavaScript 前端开发 编译器
TypeScript中的高级类型:联合类型、交叉类型与条件类型深入解析
【4月更文挑战第23天】探索TypeScript的高级类型。这些特性增强类型系统的灵活性,提升代码质量和维护性。
message: 没有找到可以构建的 NPM 包,请确认需要参与构建的 npm 都在 `miniprogra
message: 没有找到可以构建的 NPM 包,请确认需要参与构建的 npm 都在 `miniprogra
|
1月前
|
JavaScript 安全
TypeScript 中的高级类型转换技术:映射类型、条件类型和类型推断
TypeScript 中的高级类型转换技术:映射类型、条件类型和类型推断
|
1月前
react+typescript给state和props定义指定类型
react+typescript给state和props定义指定类型
16 1
|
1月前
|
供应链 JavaScript Shell
供应链投毒预警 | 恶意NPM包利用Windows反向shell后门攻击开发者
本周(2024年02月19号),悬镜供应链安全情报中心在NPM官方仓库(https://npmjs.com)中发现多起NPM组件包投毒事件。攻击者利用包名错误拼写方式 (typo-squatting)在NPM仓库中连续发布9个不同版本的恶意包,试图通过仿冒合法组件(ts-patch-mongoose)来攻击潜在的NodeJS开发者。
33 2

推荐镜像

更多