让自己的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仓库啦。

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

相关文章
|
5月前
|
JavaScript 前端开发
揭秘 TypeScript 条件类型:超越简单类型检查
揭秘 TypeScript 条件类型:超越简单类型检查
|
5月前
|
JavaScript 安全 索引
TypeScript 高级类型工具:Partial, Required, Record 的妙用与陷阱
TypeScript 高级类型工具:Partial, Required, Record 的妙用与陷阱
|
5月前
|
JavaScript 安全 IDE
TypeScript 类型体操:别让 `any` 毁了你的安全网!
TypeScript 类型体操:别让 `any` 毁了你的安全网!
|
5月前
|
JavaScript 安全 编译器
TypeScript 类型守卫:让你的类型系统更智能
TypeScript 类型守卫:让你的类型系统更智能
|
10月前
|
存储 安全 JavaScript
TypeScript-内置应用程序类型-Recode
通过使用 `Record` 类型,开发者可以显著提升代码的安全性和可维护性。无论是配置对象、字典结构还是动态表单,`Record` 类型都提供了一个简洁、类型安全的解决方案。
448 82
|
8月前
|
存储 JavaScript 前端开发
在NodeJS中使用npm包进行JS代码的混淆加密
总的来说,使用“javascript-obfuscator”包可以帮助我们在Node.js中轻松地混淆JavaScript代码。通过合理的配置,我们可以使混淆后的代码更难以理解,从而提高代码的保密性。
717 9
|
JavaScript 前端开发 安全
深入理解TypeScript:增强JavaScript的类型安全性
【10月更文挑战第8天】深入理解TypeScript:增强JavaScript的类型安全性
307 0
|
JavaScript 前端开发 开发者
深入理解TypeScript:类型系统与实用技巧
【10月更文挑战第8天】深入理解TypeScript:类型系统与实用技巧
|
11月前
|
存储 资源调度 JavaScript
npm、cnpm 和 pnpm 是三种常用的 Node.js 包管理工具
npm、cnpm 和 pnpm 是三种常用的 Node.js 包管理工具。npm 是官方默认的包管理器,提供依赖管理、安装和更新等功能;cnpm 是由阿里巴巴开发的 npm 镜像,专为中国大陆用户优化,解决下载速度慢的问题;pnpm 通过硬链接技术提高安装速度并节省磁盘空间,特别适合磁盘资源紧张的环境。三者命令类似,但各有特色,开发者可根据需求选择合适的工具。
1115 5
|
设计模式 JavaScript 安全
TypeScript性能优化及代码质量提升的重要性、方法与策略,包括合理使用类型注解、减少类型断言、优化模块导入导出、遵循编码规范、加强代码注释等
本文深入探讨了TypeScript性能优化及代码质量提升的重要性、方法与策略,包括合理使用类型注解、减少类型断言、优化模块导入导出、遵循编码规范、加强代码注释等,旨在帮助开发者在保证代码质量的同时,实现高效的性能优化,提升用户体验和项目稳定性。
377 6

推荐镜像

更多
  • NPM