前言

本文主要講怎么寫(xiě)一個(gè)typescript的描述文件（以d.ts結(jié)尾的文件名，比如xxx.d.ts)。

最近開(kāi)始從js轉(zhuǎn)ts了。但是要用到一些描述文件（d.ts），常用的比如jquery等都可以通過(guò) npm下載到別人已經(jīng)寫(xiě)好的npm install @types/jquery。但是還是有一些小眾的或者公司內(nèi)部的公共庫(kù)或者以前寫(xiě)過(guò)的公用js代碼需要自己手動(dòng)寫(xiě)描述文件。

之前也從網(wǎng)上面也找了一些資料，但還是看的云里霧里模糊不清，經(jīng)過(guò)一段摸索，將摸索的結(jié)果記錄下來(lái)，也希望可以給別人一個(gè)參考。

如果你只寫(xiě)js，d.ts對(duì)你來(lái)說(shuō)也是有用的，大部分編輯器能識(shí)別d.ts文件，當(dāng)你寫(xiě)js代碼的時(shí)候給你智能提示。效果像這樣：

詳情可以看我以前寫(xiě)過(guò)的一些文章：http://www.dbjr.com.cn/article/138211.htm

通常，我們寫(xiě)js的是時(shí)候有兩種引入js的方式：

1，在html文件中通過(guò)<script>標(biāo)簽全局引入全局變量。

2，通過(guò)模塊加載器require其他js文件：比如這樣var j=require('jquery')。

全局類型

首先以第一種方式舉例。

變量

比如現(xiàn)在有一個(gè)全局變量，那對(duì)應(yīng)的d.ts文件里面這樣寫(xiě)。

declare var aaa:number

其中關(guān)鍵字declare表示聲明的意思。全局變量是aaa,類型是數(shù)字類型（number）。當(dāng)然了也可以是string類型或者其他或者：

declare var aaa:number|string //注意這里用的是一個(gè)豎線表示"或"的意思

如果是常量的話用關(guān)鍵字const表示：

declare const max:200

函數(shù)

由上面的全局變量的寫(xiě)法我們很自然的推斷出一個(gè)全局函數(shù)的寫(xiě)法如下：

/** id是用戶的id，可以是number或者string */
decalre function getName(id:number|string):string

最后的那個(gè)string表示的是函數(shù)的返回值的類型。如果函數(shù)沒(méi)有返回值可以用void表示。

在js里面調(diào)用的時(shí)候就會(huì)提示：

我們上面寫(xiě)的注釋，寫(xiě)js的時(shí)候還可以提示。

有時(shí)候同一個(gè)函數(shù)有若干種寫(xiě)法：

get(1234)
get("zhangsan",18)

那么d.ts對(duì)應(yīng)的寫(xiě)法：

declare function get(id: string | number): string
declare function get(name:string,age:number): string

如果有些參數(shù)可有可無(wú)，可以加個(gè)?表示非必須。

declare function render(callback?:()=>void): string

js中調(diào)用的時(shí)候，回調(diào)傳不傳都可以：

render()
render(function () {
 alert('finish.')
})

class

當(dāng)然除了變量和函數(shù)外，我們還有類（class）。

declare class Person {
 static maxAge: number //靜態(tài)變量
 static getMaxAge(): number //靜態(tài)方法
 constructor(name: string, age: number) //構(gòu)造函數(shù)
 getName(id: number): string 
}

constructor表示的是構(gòu)造方法：

其中static表示靜態(tài)的意思，用來(lái)表示靜態(tài)變量和靜態(tài)方法：

對(duì)象

declare namespace OOO{ 
}

當(dāng)然了這個(gè)對(duì)象上面可能有變量，可能有函數(shù)可能有類。

declare namespace OOO{
 var aaa: number | string
 function getName(id: number | string): string
 class Person {
 static maxAge: number //靜態(tài)變量
 static getMaxAge(): number //靜態(tài)方法
 constructor(name: string, age: number) //構(gòu)造函數(shù)
 getName(id: number): string //實(shí)例方法
 }
}

其實(shí)就是把上面的那些寫(xiě)法放到這個(gè)namespace包起來(lái)的大括號(hào)里面，注意括號(hào)里面就不需要declare關(guān)鍵字了。
效果：

對(duì)象里面套對(duì)象也是可以的：

declare namespace OOO{
 var aaa: number | string
 // ...
 namespace O2{
 let b:number
 }
}

效果：

混合類型

有時(shí)候有些值既是函數(shù)又是class又是對(duì)象的復(fù)雜對(duì)象。比如我們常用的jquery有各種用法：

new $()
$.ajax()
$()

既是函數(shù)又是對(duì)象

declare function $2(s:string): void
declare namespace $2{
 let aaa:number
}

效果：

作為函數(shù)用：

作為對(duì)象用：

也就是ts會(huì)自動(dòng)把同名的namespace和function合并到一起。

既是函數(shù)，又是類（可以new出來(lái)）

// 實(shí)例方法 
interface People{
 name: string
 age: number
 getName(): string
 getAge():number
}
interface People_Static{
 new (name: string, age: number): People
 /** 靜態(tài)方法 */
 staticA():number
 
 (w:number):number
}
declare var People:People_Static

效果：

作為函數(shù)使用：

類的靜態(tài)方法：

類的構(gòu)造函數(shù)：

類的實(shí)例方法：

模塊化

除了上面的全局的方式，我們有時(shí)候還是通過(guò)require的方式引入模塊化的代碼。

比如這樣的效果：

對(duì)應(yīng)的寫(xiě)法是這樣的：

declare module "abcde" {
 export let a: number
 export function b(): number
 export namespace c{
  let cd: string
 }
 }

其實(shí)就是外面套了一層 module "xxx"，里面的寫(xiě)法和之前其實(shí)差不多，把declare換成了export。

此外，有時(shí)候我們導(dǎo)出去的是一個(gè)函數(shù)本身，比如這樣的：

對(duì)應(yīng)的寫(xiě)法很簡(jiǎn)單，長(zhǎng)這個(gè)樣子：

declare module "app" {
 function aaa(some:number):number
  export=aaa
 }

以此類推，導(dǎo)出一個(gè)變量或常量的話這么寫(xiě)：

declare module "ccc" {
 const c:400
  export=c
 }

效果：

UMD

有一種代碼，既可以通過(guò)全局變量訪問(wèn)到，也可以通過(guò)require的方式訪問(wèn)到。比如我們最常見(jiàn)的jquery：

其實(shí)就是按照全局的方式寫(xiě)d.ts，寫(xiě)完后在最后加上declare namespace "xxx"的描述：

declare namespace UUU{
 let a:number
}
 
declare module "UUU" {
 export =UUU
}

效果這樣：

作為全局變量使用：

作為模塊加載使用：

其他

有時(shí)候我們擴(kuò)展了一些內(nèi)置對(duì)象。比如我們給Date增加了一個(gè)format的實(shí)例方法：

對(duì)應(yīng)的d.ts描述文件這樣寫(xiě)：

interface Date {
 format(f: string): string
}

總結(jié)

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問(wèn)大家可以留言交流，謝謝大家對(duì)腳本之家的支持。

最新評(píng)論