企业🤖AI Agent构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
[TOC] >[success] # 声明文件 使用 **第三方库** 时,很多 **第三方库** 不是通过 **TypeScript** 写的,它们是通过原生 **Javascript** 或 **浏览器** 或是 **nodeJS** 提供好的 **Runtime** 对象,比如 **document.window** , **nodeJS** 的 **process** 对象,它们直接在 **TS** 文件中使用肯定会 **报错** 。 1. **错误场景** **场景** :那么假如我们要使用 **第三方** 的 **jQuery库** ,常见的方式就是在 **html** 文件中通过 **script** 标签引入 **jQuery** ,然后就可以 **全局使用 jQuery** 了代码如下: **index.ts** ~~~ jQuery('#foo') ~~~ **编辑器图片** : ![](https://img.kancloud.cn/a9/6b/a96bcf59b6513eac52c99a227b669790_360x123.png) 我们通常用 **jQuery('#foo')** 这种方式来获取 **标签元素** ,但是在 **ts 文件** 中,会报错,它不知道 **jQuery** 是什么,所以这里会报错。 2. **解决办法** 上面那种情况,我们可以使用 **declare 关键字来告诉 tsc 这个变量已经在其他地方定义了,你拿来用就好了,请不要报错** ,代码如下: **index.ts** ~~~ // 声明jQuery declare var jQuery: (selector: string) => any; // 使用jQuery jQuery('#foo') ~~~ **编辑器图片**: ![](https://img.kancloud.cn/d6/be/d6be896666624e3460ea6d5829297356_444x107.png) 3. **标准写法** 通常我们会把 **declare声明语句** 放入一个单独的文件中,一般是以 **.d.ts** 结尾的文件,**d** 就代表 **声明**,它说明该文件只有适配 **ts** 的 **类型声明**,我在 **根目录** 下创建了一个 **jQuery.d.ts** ,就是声明文件,此时我把 **index.ts** 中的声明 **jQuery** 的代码放入到 **jQuery.d.ts** 中,代码如下: **jQuery.d.ts** ~~~ // 声明jQuery // 注意:var jQuery 它并没有真正的定义一个变量的实现,只是定义了全局变量 jQuery 的类型, // 仅仅会用于编译时的检查,并不是实现功能的真正代码。 declare var jQuery: (selector: string) => any; ~~~ **index.ts** ~~~ // 使用jQuery jQuery('#foo') ~~~ 这样其他地方在 **ts** 中使用 **jQuery** 就不会报错了,因为一般来说,默认 **ts** 会解析项目中所有的 **.ts 与 .d.ts** 文件,所以当我们将 **jQuery.d.ts** 放到项目中时,我们 **所有的 ts 文件都可以获得 jQuery 的类型定义了** 。 >[success] ## 第三方库 当我们使用 **第三方库** 时,是不是还要给它改装呢? 从头到尾 **declare** 一大堆文件呢 ?当然是不用的啦,我们有 **第三方声明文件** ,社区跟官方早就为我们写好了,比如 **jQuery** ,我们只需要 **npm install --save @types/jquery** 就会直接安装 **jQuery** 的 **类型文件** 了,我们 **jQuery.d.ts** 文件中的内容就可以去掉了,代码如下: **index.ts** ~~~ jQuery('#id').addClass('color-red') ~~~ 编辑器图片: ![](https://img.kancloud.cn/b3/04/b3041a0d52cce50c2093e416efe97b90_1060x911.png) **jQuery 支持的方法** 以及对应的 **文档** 就会直接提示出来,这样我们就会非常的方便。 >[success] ## 提示 我们如果想找 **第三方** 的 **插件(库)** 的 **声明文件** ,可以从 [TypeSeach](https://www.typescriptlang.org/dt/search?search=) 中去搜索支持 **ts**的 **插件(库)** 的 **声明文件** ,除了在 **TypeSeach** 中可以找到 **插件(库)** 的 **声明文件** ,现在一般的 **插件(库)** 都是 **源代码自带声明文件** ,举个例子,假如用 **npm install** 安装某个 **插件(库)** 时,它的 **类型定义就包含其中** 了,不需要像我们使用 **jQuery** 时候那样,**先安装本体,再安装声明文件** ,这种情况下我们可以 **一次安装,双重搞定** 。 <br/> 大家可能会好奇 **TypeScript** 是怎样被定义,怎么样被加载进来的呢?默认情况下所有可见的 **类型文件的声明** 都会在 **编译过程中** 到 **node_modules > @types** 下,以及它们的 **子文件夹** 下,在 **使用的时候都会被加载进来** , **当一个第三方库没有提供声明文件时,就需要自己来声明文件了** ,前面讲了一些简单的 **声明文件** ,而真正书写一个 **声明文件** 不是很简单的事情,不过它们也就是 **declare** 语法的组合而已,**declare** 可以声明:**变量、 函数、 类、 接口** 等等,这里不再详细讲了,想了解可以到官方文档中看。