声明文件:
当使用第三方库时,我们需要引用它的声明文件,才能获得对应的代码补全、接口提示等功能。
新语法索引
由于本章涉及大量新语法,故在本章开头列出新语法的索引,方便大家在使用这些新语法时能快速查找到对应的讲解:
-
declare var
声明全局变量 -
declare function
声明全局方法 -
declare class
声明全局类 -
declare enum
声明全局枚举类型 -
declare namespace
声明(含有子属性的)全局对象 -
interface
和type
声明全局类型 -
export
导出变量 -
export namespace
导出(含有子属性的)对象 -
export default
ES6 默认导出 -
export =
commonjs 导出模块 -
export as namespace
UMD 库声明全局变量 -
declare global
扩展全局变量 -
declare module
扩展模块 -
/// <reference />
三斜线指令什么是声明语句
假如我们想使用第三方库 jQuery,一种常见的方式是在 html 中通过
<script>
标签引入 jQuery,然后就可以使用全局变量$
或jQuery
了。我们通常这样获取一个
$('#foo'); // or jQuery('#foo');id
是foo
的元素:但是在 ts 中,编译器并不知道
jQuery('#foo'); // ERROR: Cannot find name 'jQuery'.$
或jQuery
是什么东西1:这时,我们需要使用
declare var jQuery: (selector: string) => any; jQuery('#foo');declare var
来定义它的类型2:上例中,
jQuery('#foo');declare var
并没有真的定义一个变量,只是定义了全局变量jQuery
的类型,仅仅会用于编译时的检查,在编译结果中会被删除。它编译结果是:除了
什么是声明文件:declare var
之外,还有其他很多种声明语句。通常我们会把声明语句放到一个单独的文件(
// src/jQuery.d.ts declare var jQuery: (selector: string) => any; // src/index.ts jQuery('#foo');jQuery.d.ts
)中,这就是声明文件3:声明文件必需以
.d.ts
为后缀。一般来说,ts 会解析项目中所有的
/path/to/project ├── src | ├── index.ts | └── jQuery.d.ts └── tsconfig.json*.ts
文件,当然也包含以.d.ts
结尾的文件。所以当我们将jQuery.d.ts
放到项目中时,其他所有*.ts
文件就都可以获得jQuery
的类型定义了。假如仍然无法解析,那么可以检查下
tsconfig.json
中的files
、include
和exclude
配置,确保其包含了jQuery.d.ts
文件。这里只演示了全局变量这种模式的声明文件,假如是通过模块导入的方式使用第三方库的话,那么引入声明文件又是另一种方式了。
第三方声明文件当然,jQuery 的声明文件不需要我们定义了,社区已经帮我们定义好了:jQuery in DefinitelyTyped。
我们可以直接下载下来使用,但是更推荐的是使用
@types
统一管理第三方库的声明文件。
npm install @types/jquery --save-dev 可以在 https://microsoft.github.io/TypeSearch/搜索你需要的声明文件。 书写声明文件:@types
的使用方式很简单,直接用 npm 安装对应的声明模块即可,以 jQuery 举例:当一个第三方库没有提供声明文件时,我们就需要自己书写声明文件了。前面只介绍了最简单的声明文件内容,而真正书写一个声明文件并不是一件简单的事,以下会详细介绍如何书写声明文件。
在不同的场景下,声明文件的内容和使用方式会有所区别。
库的使用场景主要有以下几种:
-
全局变量:通过
<script>
标签引入第三方库,注入全局变量 -
npm 包:通过
import foo from 'foo'
导入,符合 ES6 模块规范 -
UMD 库:既可以通过
<script>
标签引入,又可以通过import
导入 -
直接扩展全局变量:通过
<script>
标签引入后,改变一个全局变量的结构 -
在 npm 包或 UMD 库中扩展全局变量:引用 npm 包或 UMD 库后,改变一个全局变量的结构
-
模块插件:通过
全局变量<script>
或import
导入后,改变另一个模块的结构全局变量是最简单的一种场景,之前举的例子就是通过
<script>
标签引入 jQuery,注入全局变量$
和jQuery
。使用全局变量的声明文件时,如果是以
/path/to/project ├── src | ├── index.ts | └── jQuery.d.ts └── tsconfig.jsonnpm install @types/xxx --save-dev
安装的,则不需要任何配置。如果是将声明文件直接存放于当前项目中,则建议和其他源码一起放到src
目录下(或者对应的源码目录下):如果没有生效,可以检查下
tsconfig.json
中的files
、include
和exclude
配置,确保其包含了jQuery.d.ts
文件。全局变量的声明文件主要有以下几种语法:
-
declare var
声明全局变量 -
declare function
声明全局方法 -
declare class
声明全局类 -
declare enum
声明全局枚举类型 -
declare namespace
声明(含有子属性的)全局对象 -
interface
和type
声明全局类型declare var
在所有的声明语句中,
// src/jQuery.d.ts declare let jQuery: (selector: string) => any; // src/index.ts jQuery('#foo'); // 使用 declare let 定义的 jQuery 类型,允许修改这个全局变量 jQuery = function(selector) { return document.querySelector(selector); }; 而当我们使用declare var
是最简单的,如之前所学,它能够用来定义一个全局变量的类型。与其类似的,还有declare let
和declare const
,使用let
与使用var
没有什么区别:const
定义时,表示此时的全局变量是一个常量,不允许再去修改它的值了4: // src/jQuery.d.ts declare const jQuery: (selector: string) => any; jQuery('#foo'); // 使用 declare const 定义的 jQuery 类型,禁止修改这个全局变量 jQuery = function(selector) { return document.querySelector(selector); }; // ERROR: Cannot assign to 'jQuery' because it is a constant or a read-only property.一般来说,全局变量都是禁止修改的常量,所以大部分情况都应该使用
const
而不是var
或let
。需要注意的是,声明语句中只能定义类型,切勿在声明语句中定义具体的实现5:
declare const jQuery = function(selector) { return document.querySelector(selector); }; // ERROR: An implementation cannot be declared in ambient contexts. declare function:
// src/jQuery.d.ts declare function jQuery(selector: string): any; // src/index.ts jQuery('#foo');declare function
用来定义全局函数的类型。jQuery 其实就是一个函数,所以也可以用function
来定义:
-
-