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

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

相关文章
|
20天前
|
JavaScript 前端开发 Java
npm学习一:npm 包管理工具 学习、使用。
这篇文章介绍了npm的基础知识和常用命令,包括安装包、查看包信息、管理依赖等操作,并提供了如何删除npm安装的镜像以及如何彻底删除node_modules文件夹的具体步骤。
45 2
|
2月前
|
JavaScript
typeScript进阶(9)_type类型别名
本文介绍了TypeScript中类型别名的概念和用法。类型别名使用`type`关键字定义,可以为现有类型起一个新的名字,使代码更加清晰易懂。文章通过具体示例展示了如何定义类型别名以及如何在函数中使用类型别名。
36 1
typeScript进阶(9)_type类型别名
|
17天前
|
JavaScript 前端开发 安全
深入理解TypeScript:增强JavaScript的类型安全性
【10月更文挑战第8天】深入理解TypeScript:增强JavaScript的类型安全性
28 0
|
17天前
|
JavaScript 前端开发 开发者
深入理解TypeScript:类型系统与实用技巧
【10月更文挑战第8天】深入理解TypeScript:类型系统与实用技巧
|
2月前
|
存储 JavaScript
typeScript进阶(11)_元组类型
本文介绍了TypeScript中的元组(Tuple)类型,它是一种特殊的数组类型,可以存储不同类型的元素。文章通过示例展示了如何声明元组类型以及如何给元组赋值。元组类型在定义时需要指定数组中每一项的类型,且在赋值时必须满足这些类型约束。此外,还探讨了如何给元组类型添加额外的元素,这些元素必须符合元组类型中定义的类型联合。
42 0
|
2月前
|
JavaScript
typeScript进阶(10)_字符串字面量类型
本文介绍了TypeScript中的字符串字面量类型,这种类型用来限制变量只能是某些特定的字符串字面量。通过使用`type`关键字声明,可以确保变量的值限定在预定义的字符串字面量集合中。文章通过示例代码展示了如何声明和使用字符串字面量类型,并说明了它在函数默认参数中的应用。
33 0
|
18天前
|
JavaScript 前端开发 Java
npm学习一:npm 包管理工具 学习、使用。
这篇文章是关于npm包管理工具的学习、使用指南,包括npm概述、基础命令和如何安装webpack。
33 3
npm学习一:npm 包管理工具 学习、使用。
|
1天前
|
JavaScript 开发者
在 Babel 插件中使用 TypeScript 类型
【10月更文挑战第23天】可以在 Babel 插件中更有效地使用 TypeScript 类型,提高插件的开发效率和质量,减少潜在的类型错误。同时,也有助于提升代码的可理解性和可维护性,使插件的功能更易于扩展和升级。
|
13天前
|
JavaScript 前端开发
TypeScript【类型别名、泛型】超简洁教程!再也不用看臭又长的TypeScript文档了!
【10月更文挑战第11天】TypeScript【类型别名、泛型】超简洁教程!再也不用看臭又长的TypeScript文档了!
|
15天前
|
JavaScript 前端开发 安全
TypeScript【基础类型】超简洁教程!再也不用看臭又长的TypeScript文档了!
【10月更文挑战第9天】TypeScript【基础类型】超简洁教程!再也不用看臭又长的TypeScript文档了!

推荐镜像

更多