如何编写.d.ts这样的类型定义文件

类型定义文件是帮助TS文件,去理解引入的JS库里的内容的。因为这些JS库里,没有TS要求的类型的概念。
我们写代码的时候,通常会遇到一个场景,引入一个类库,发现这个库是用js代码写的,然后ts里用这样的类库就会有问题,导致我们需要安装类库的类型定义文件。安装这样的类型定义文件是非常简单的,但是类型定义文件是怎么写的呢? 原理是什么呢?
  • 我们先在index.html里引入 jquery文件。
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Document</title>
  <script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.4.1/jquery.js"></script>
  <script src="./page.ts"></script>
</head>
<body>
  
</body>
</html>
  • 然后我们可以在page.ts里调用jquery的方法,我们会发现,虽然可以运行,但是编辑器会飘红,告诉我们需要安装jquery 的类型文件。因为jquery 是JS写的。npm i --save-dev @types/jquery
$(function(){
  alert(123);
})
image.png

现在我们不安装别人写的jquery 的类型定义文件,我们自己写一个类型定义文件 jquery.d.ts。帮助page.ts去理解jquery的JS语法。

  • 我们调用的$是一个函数,接收一个参数也是一个函数,$函数返回值是void。参数这个函数返回值也是void
$(function(){
  alert(123);
})
  • 我们可以这样写,通过declare var定义全局变量;.d.ts 文件中的顶级声明必须以 "declare" 或 "export" 修饰符开头
//定义全局变量 
declare var $: (params:()=>void) => void;
  • 我们刚才把$定义为一个全局变量。还可以把$定义为一个全局函数
// 定义全局函数
declare function $(params:()=>void): void;
函数重载,对一个函数名字,可以写多个全局函数声明。也就是说一个函数,可以有多种形式。
  • 当我们调用的其他方法,编辑器会飘红,因为我们刚才在jquery.d.ts文件里,只是定义了函数接收的参数是一个函数。而不是字符串
$(function(){
  $('body').html('<div>123</div>');
})
  • 我们可以再次定义一个$全局函数声明,这次接收的参数是一个字符串,返回的是对象,对象里有一个属性html,这属性的类型也是函数,接收一个字符串参数,返回一个对象
declare function $(params: string): {
  html: (html: string) => {};
};
  • 还可以写的更简洁一点
interface JqueryInstance {
  html:(html:string)=>JqueryInstance
}
// 当传函数的时候,返回值是空
declare function $(readyFunc: () => void): void;
// 当传一个选择器的时候,返回值是一个juqery对象
declare function $(selector: string): JqueryInstance;
函数重载的另外一种写法.这种写法利用了interface 的一种特性,就是在接口里定义两个函数的实现的时候,实际上就是一种函数的重载。表示Jquery 可以有两种实现方式。
interface Jquery {
  (readyFunc: () => void): void;
  (selector: string): JqueryInstance;
}
当然,如果只是声明了Jquery 接口,那么$符号是不可以用的,所以可以定义一下$的类型。
interface Jquery {
  (readyFunc: () => void): void;
  (selector: string): JqueryInstance;
}

declare var $: Jquery;
如何对对象进行类型定义,以及如何对类进行类型定义,以及命名空间的嵌套
// new $.fn.init();
declare namespace $ {
  namespace fn {
    class init {}
  }
}

$(function(){
  $('body').html('<div>123</div>');
  new $.fn.init();
})
总之,当我们引入外部的一个库,这个库可能会有一些全局的变量、方法、对象无法被typescript无法识别这些东西,我们就可以通过全局的声明的语法让typescript理解库里的这些东西。让我们在typescript里使用这些变量、方法、对象的时候不再报错。
  • 定义全局变量 用 declare var
  • 定义全局函数 用 declare function
  • 定义全局对象 用 declare namespace
  • 定义全局函数重载的时候,有了两种方式
declare function $(readyFunc: () => void): void;
declare function $(params: string): JqueryInstance;

// interface Jquery {
//   (readyFunc: () => void): void;
//   (selector: string): JqueryInstance;
// }
  • 如果想要$即是函数又是对象的时候,用interface 就不合适了,还是需要用declare
declare function $(readyFunc: () => void): void;
declare function $(params: string): JqueryInstance;
declare namespace $ {
  namespace fn {
    class init {}
  }
}
ES6的方式,如何通过.d.ts文件,声明一些模块。
  • 首先安装一下jquery npm install jquery --save.然后在page.ts里引入,会发现报错。原因是 我们的jquery.d.ts文件,并不是模块化声明的。
    image.png
  • 下边我们模块化声明一下 jquery.d.ts。注意 declare 后边跟 module
// ES6 模块化
// 定义一个模块叫做jquery 和通过 import引入的 jquery要一致
declare module 'jquery' {
  interface JqueryInstance {
    html:(html:string)=>JqueryInstance
  }

  // 混合类型
  function $(readyFunc: () => void): void;
  function $(params: string): JqueryInstance;
  namespace $ {
    namespace fn {
      class init {}
    }
  }
}
  • 这个时候,通过 import引入的 就不会报错了,但是方法的引用还是会报错。原因是,当我们用模块化定义d.ts文件的时候,记得在最后一定要把外部要用的东西通过export导出去
    image.png
declare module 'jquery' {
  interface JqueryInstance {
    html:(html:string)=>JqueryInstance
  }

  // 混合类型
  function $(readyFunc: () => void): void;
  function $(params: string): JqueryInstance;
  namespace $ {
    namespace fn {
      class init {}
    }
  }
  export = $
}
  • 这样,我们定义了一个jquery的模块,里边有关于jquery的混合类型的定义,最终我们把导出出去,通过这个导出的我们引入后,就可以拿到$上各种方法和命名空间。
这种是ES6的模块化方式,还有AMD的等等。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容