TypeScript11--声明文件

 声明文件:

    出现背景:

        TS是js的超集也是一门强类型的语言,在开发过程中难描要用到其他第三方的库。我们虽然可以通过引用调用库中的类和方法,但是却无法通过TypeScript的诸多检查。

     解决方法:

        为了解决上述问题,需要把这些第三方库里的函数和方法体去掉后只保留导出类型声明,生成一个只描述JavaScript库和模块信息的声明文件。通过引用这个声明文件,就可以借用TypeScript的各种特性来使用库文件了。

    识别库的类型:

        1.全局库

        早期版本的jQuery就是全局库(通过html中script标签引入)。通常有以下几种特征

            ①顶级的声明是var或者function

            ②有window或者document这些DOM对象存在

            ③对象一般会赋值到window上

        2.CommonJS

        NodeJs模块化采用的规范。通常有以下几种特征

            ①赋值给exports或者module.exports

            ②无条件调用require

        3.AMD

        前端框架普遍采用的模块化的规范,通常会无条件调用define或者require

        4.通用模块规范(UMD)

        为了能同时支持上述所有风格的库声明方式,就有了通用模块规范(UMD)。

            ①在文件顶端会有一大串typeof XXX的判断

            ②同时有exports、define这种关键词

针对全局库如何编写一个声明文件:

    demo1( 自己建全局库,编写声明文件):

        我们在template/index.html 引入handle-title.js文件

        这里为什么是 ./handle-title.js而不是../modules/handle-title.js呢?我们执行npm run buid命令查看编译结果

        我们可以发现编译后的结果 dist文件夹下是没有 handle-title.js文件的。

        于是我们在webpack中引入copy-webpack-plugin(拷贝插件)并重新编译,如果成功dist文件夹下将出现handle-title.js文件。

        按照常理来说。我们自己编写的handle-title.js文件是一个全局库,只要一次引入,不管在哪都可以使用。可事实真的如此么?

        编译报错,ts找不到documentTitle。这是因为我们还没有声明文件。(绕过TS严格的检查。起到一个占位的作用。。。)

        下图中的 global.d.ts就是针对handle-title.js的声明文件

    demo2( 直接扩展全局变量):


    总结:

        declare var声明全局变量

        declare function声明全局方法

        declare class声明全局类

        declare enum声明全局枚举类型

        declare namespace声明全局对象(含有子属性)

        interface和type声明全局类型

针对npm包如何编写一个声明文件:

        npm 包一般是通过 import foo from 'foo'导入的 。他的声明文件可能存在于两个地方:

        1.与该 npm 包绑定在一起

        2.在@types里。我们尝试用 npm install @types/foo --save-dev 

        如果找不到,我们就要自己写一个了

        1.在node_modules下,创建一个 node_modules/@types/foo/index.d.ts 文件(不在git仓库中,不建议)

        2.创建一个 types 目录,专门用来管理自己写的声明文件,将 foo 的声明文件放到 types/foo/index.d.ts 中。这种方式需要配置下 tsconfig.json 中的 paths 和 baseUrl 字段。


        npm 包的声明文件与全局变量的声明文件有很大区别。在 npm 包的声明文件中,使用declare不再会声明一个全局变量,而只会在当前文件中声明一个局部变量。只有在声明文件中使用export导出,然后在使用方import导入后,才会应用到这些类型声明。

        下面这两种写法等价

针对UMD库如何编写一个声明文件:

        既可以通过<script>标签引入,又可以通过import导入的库,称为 UMD 库。相比于 npm 包的类型声明文件,我们需要额外声明一个全局变量,为了实现这种方式,ts 提供了一个新语法 export as namespace

在 npm 包或 UMD 库中扩展全局变量

        使用 declare global 可以在 npm 包或者 UMD 库的声明文件中扩展全局变量的类型

模块插件:

       扩展模块 :declare module

声明文件中的依赖:

    1.import:

        一个声明文件有时会依赖另一个声明文件中的类型,比如在前面的 declare module 的例子中,我们就在声明文件中导入了 moment,并且使用了 moment.CalendarKey 这个类型:

    2.三斜线指令:

        在全局变量的声明文件中,是不允许出现 import, export 关键字的。一旦出现了,那么他就会被视为一个 npm 包或 UMD 库,就不再是全局变量的声明文件了。故当我们在书写一个全局变量的声明文件时,如果需要引用另一个库的类型,那么就必须用三斜线。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,080评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,422评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,630评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,554评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,662评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,856评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,014评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,752评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,212评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,541评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,687评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,347评论 4 331
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,973评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,777评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,006评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,406评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,576评论 2 349