文档章节

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

全体人员
 全体人员
发布于 2016/09/15 17:47
字数 1128
阅读 7932
收藏 9

作者: 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
深圳
程序员
私信 提问
加载中

评论(1)

T
Txy_2012
赞赞赞赞赞赞
D2 日报 2019年1月2日

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

D2Projects开源组
01/02
0
0
Vue with TypeScript

最近尝试了一下 TypeScript,试着把一个 Vue 项目改成了 TypeScript 的,感觉还不错。 目前 Vue 和 TypeScript 的配合还不算很完美,Vuex 和 TypeScript 的配合挺糟糕的,尝试需要谨慎,如果...

凤晴铃玉
2018/10/31
0
0
从 Vue typings 看 “this”

在 2.5.0 版本中,Vue 大大改进了类型声明系统以更好地使用默认的基于对象的 API。 意味着当我们仅是安装 Vue 的声明文件时,一切也都将会按预期进行: ,就是 Vue; 属性上,具有 Methods ...

三毛丶
2018/10/28
0
0
TypeScript基础入门之Javascript文件类型检查(三)

转发 TypeScript基础入门之Javascript文件类型检查(三) 继续上篇文章【TypeScript基础入门之Javascript文件类型检查(二)】 支持JSDoc 下面的列表概述了使用JSDoc注释在JavaScript文件中提供类...

durban
2018/10/31
0
0
旧项目TypeScript改造问题与解决方案记

概述 由于本次改造的项目为一个通过NPM进行发布的基础服务包,因此本次采用TypeScript进行改造的目标是移除Babel全家桶,减小包体积,同时增加强类型约束从而避免今后开发时可能的问题。 本次...

黄Java
2018/07/25
0
0

没有更多内容

加载失败,请刷新页面

加载更多

MySQL的分表与分区

MySQL分表分区是解决大数据量导致MySQL性能低下的两种方法。 什么是MySQL分表 从表面意思上看,MySQL分表就是将一个表分成多个表,数据和数据结构都有可能会变。MySQL分表分为垂直分表和水平...

吴伟祥
41分钟前
2
0
MySQL查询执行

当我们希望MySQL能够以更高的性能运行查询时,最好的办法就是弄清楚MySQL是如何优化和执行查询的。一旦理解了这一点,很多查询优化工作实际上就是遵循一些原则让优化器能够按照预想的合理方式...

问题终结者
今天
1
0
CDH5动静态资源池配置与回滚

关于动态 静态资源池的配置以前都有提过,可以从以下几篇了解: YARN动态资源池配置案例 https://yq.aliyun.com/ziliao/346856# Hadoop YARN配置参数剖析(4)—Fair Scheduler相关参数 Hadoop...

hblt-j
今天
3
0
WordPress仿站实战教程

有一个月没有写blog了,一直在学习wordpress的知识,现在能够进行简单的政府企业门户网站的仿制,wordpress的主题订制,一般是对前端要求比较高,wordpress学会了,建站还是非常的快的。下面...

临江仙卜算子
今天
4
0
图像库stb_image

https://github.com/nothings/stb 目前一般主流的图像格式也就是bmp,jpg,png,tga,dds,除了DDS一般是给DX用的,虽然一堆OpenGL程序也有用的,但是我一般只用png和tga, png不用说了,带a...

robslove
今天
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部