文档章节

TypeScript 的两种声明文件写法的区别和根本意义

手握华为赛神仙
 手握华为赛神仙
发布于 2016/09/15 17:47
字数 1128
阅读 4.1W
收藏 10

作者: Angus.Fenying <i.am.x.fenying@gmail.com>

日期: 2016-09-15 05:40 PM

我们知道 NPM 包可以有内建的 TS 声明文件,从而免去使用 typings 工具安装 TS 声明文件的操作。那既然可以有内建的声明文件,为何还需要额外安装呢?因为不是 所有人都在使用 TypeScript,很多 NPM 模块都是纯 JavaScript 编写的,其作者 没有太大的可能性为之编写模块声明文件。而且内建的声明文件有一定约束。

TypeScript 的 DefinitelyTyped 声明文件有两种写法,一种叫做 全局类型声明(Global Type Definition),另一个则是叫做 模块导出声明(External Module Definition)

External Module 一词源自 TypeScript 1.5 之前的 内部模块/外部模块 之说,而 1.5 之后内部模块变成了 namespace,外部模块直接化为模块, 不再有内外部模块之说。

所以这里将 External Module Definition 译为 模块导出声明 比较合适。

DefinitelyTyped 对此的说明是:

  • 如果你的模块需要将新的名称引入全局命名空间,那么就应该使用全局声明。
  • 如果你的模块无需将新的名称引入全局命名空间,那么就应该使用模块导出声明。

这两者有什么不同呢?

首先,最主要的区别在于,NPM 模块里面的内建声明文件必须使用模块导出声明写法, 否则 TypeScript 编译无法通过。下面来看一个简单的例子:

以一个名为 abc 的模块为例,TS源代码如下:

export function abc(s: string): string {

    return s.substr(0, 4);
}

其声明文件有两种写法:

  • 第一种,模块导出声明写法

    declare interface funcAbcSign {
        (s: string): string
    }
    
    export declare let abc: funcAbcSign;
    
  • 第二种,全局类型声明写法

    declare module "abc" {
        interface funcAbcSign {
            (s: string): string
        }
    
        export let abc: funcAbcSign;
    }
    

如果要理解两者的区别,首先要理解其意义。模块导出声明写法 中,单从这个文件内容 看来是无法得知这些内容属于哪个模块的。所以必须将之与模块放在一起,作为内建声明文件, TypeScript 编译器才能得知其所属的模块。(或者放进 typings 的 external 目录)

全局类型声明写法 中,实际上是将模块名称 abc 引入了全局空间,即告诉 TypeScript 编译器,存在一个叫 abc 的模块,想使用里面的名称,就 import 吧!

因为任何一个 Node.js 的模块都是必须依靠 require 加载的才能通过字段引用的方式 使用里面的名称,即是说 一个模块无法真正地将任何名称引入全局的命名空间中,所以不应该也不能在一个模块 的内建声明文件里使用全局声明写法!

这样,就明白了什么时候应该使用全局声明写法,什么时候应该使用模块导出声明写法了

如果你写的 TypeScript 文件是在浏览器上通过 <script> 标签加载的,那么里面的 变量、函数等都会被引入到全局命名空间中,这时候就需要为这个文件写一份全局类型声明 了!比如这个文件:

// 定义了一个全局变量,整个页面内都可见
let appStartedTime: Date = new Date();

你需要为之写一份 .d.ts 文件,供其它 ts 文件引用:

// 这里将变量名 appStartedTime 引入了 TypeScript 的全局命名空间中。
declare let appStartedTime: Date;

除此之外,你可以用一个全局类型声明文件定义多个模块、命名空间,例如:

// node.d.ts

declare namespace NodeJS {

    export interface Error {

        "name": string;
    }
}

declare module "http" {

    // Node built-in module http
}

declare module "fs" {

    // Node built-in module fs
}

或者深层模块声明:


declare module "sample/lib1" {

    export let name: number;
}

declare module "sample/lib2" {

    export let value: number;
}

declare module "sample" {

    export * from "sample/lib1";

    export * from "sample/lib2";
}

这是模块导出声明写法做不到的。

综上所述,最直观的解释是:

  • 全局类型声明里的名称将被引入整个 TypeScript 全局命名空间中,从引用这个 声明文件起就可以自由使用。
  • 模块导出声明里的名称必须通过 import/require 才能使用。

© 著作权归作者所有

手握华为赛神仙

手握华为赛神仙

粉丝 15
博文 13
码字总数 14020
作品 0
深圳
程序员
私信 提问
加载中

评论(2)

土逗吧
土逗吧
夸夸你
T
Txy_2012
赞赞赞赞赞赞
D2 日报 2019年1月2日

官网阅读获得更好的体验,传送门《日报 2019年1月2日》 你有一个苹果,我有一个苹果,交换之后我们还是各自有一个苹果。 你有一份知识,我有一份知识,我们互相分享一下就都有了两份知识。 ...

D2Projects开源组
2019/01/02
0
0
Node.js项目TypeScript改造指南

作者:陈晓强 前言 如果你有一个 Node.js 项目,并想使用 TypeScript 进行改造,那本文对你或许会有帮助。TypeScript 越来越火,本文不讲为什么要使用 TypeScript,也不讲基本概念。本文讲的...

WecTeam
2019/12/02
0
0
Vue 3.0前的 TypeScript 最佳入门实践

前言 我个人对更严格类型限制没有积极的看法,毕竟各类转类型的骚写法写习惯了。 然鹅最近的一个项目中,是 + ,毛计喇,学之...…真香! 1. 使用官方脚手架构建 新的 工具允许开发者 使用 ...

奇舞周刊
2019/06/24
0
0
Vue3.0 前的TypeScript 最佳入门实践

前言 我个人对更严格类型限制没有积极的看法,毕竟各类转类型的骚写法写习惯了。 然鹅最近的一个项目中,是+ ,毛计喇,学之...…真香! 1. 使用官方脚手架构建 新的工具允许开发者 使用 集成...

前端劝退师
2019/06/14
0
0
TypeScript 简明教程:基本类型(一)

本文为系列文章《TypeScript 简明教程》中的一篇。 认识 TypeScript 安装 TypeScript 基本类型(一) 从这篇文章,我们开始讲解 TypeScript 的类型系统。之前我们说到,TypeScript 是 JavaSc...

Hopsken
2019/03/06
0
0

没有更多内容

加载失败,请刷新页面

加载更多

石家庄哪里可以开汽车配件发票-中国-新闻网

石家庄哪里可以开汽车配件发票【152 * 9б 28 * 21 б9】陈生,诚、信、合、作,保、真、售、后、保、障、长、期、有、效。adb的全称为Android Debug B...

18280800244
24分钟前
36
0
石家庄哪里可以开礼品费发票-中国-新闻网

石家庄哪里可以开礼品费发票【152 * 9б 28 * 21 б9】陈生,诚、信、合、作,保、真、售、后、保、障、长、期、有、效。adb的全称为Android Debug Bri...

18281961458
24分钟前
47
0
石家庄哪里可以开运输费发票-中国-新闻网

石家庄哪里可以开运输费发票【152 * 9б 28 * 21 б9】陈生,诚、信、合、作,保、真、售、后、保、障、长、期、有、效。adb的全称为Android Debug Bri...

18281771440
25分钟前
89
0
石家庄哪里可以开办公耗材发票-中国-新闻网

石家庄哪里可以开办公耗材发票【152 * 9б 28 * 21 б9】陈生,诚、信、合、作,保、真、售、后、保、障、长、期、有、效。adb的全称为Android Debug B...

18249436294
25分钟前
37
0
石家庄哪里可以开汽车租赁费发票-中国-新闻网

石家庄哪里可以开汽车租赁费发票【152 * 9б 28 * 21 б9】陈生,诚、信、合、作,保、真、售、后、保、障、长、期、有、效。adb的全称为Android Debug...

18249436304
25分钟前
55
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部