鴻蒙TypeScript學習21天：【聲明文件】

TypeScript 作為 JavaScript 的超集，在開發過程中不可避免要引用其他第三方的 JavaScript 的庫。雖然通過直接引用可以調用庫的類和方法，但是卻無法使用TypeScript 諸如類型檢查等特性功能。為了解決這個問題，需要將這些庫里的函數和方法體去掉后只保留導出類型聲明，而產生了一個描述 JavaScript 庫和模塊信息的聲明文件。通過引用這個聲明文件，就可以借用 TypeScript 的各種特性來使用庫文件了。
參考文檔：[qr23.cn/AKFP8k]

假如我們想使用第三方庫，比如 jQuery，我們通常這樣獲取一個 id 是 foo 的元素：

$('#foo');
// 或
jQuery('#foo');

但是在 TypeScript 中，我們并不知道 $ 或 jQuery 是什么東西：

jQuery('#foo');

// index.ts(1,1): error TS2304: Cannot find name 'jQuery'.

這時，我們需要使用 declare 關鍵字來定義它的類型，幫助 TypeScript 判斷我們傳入的參數類型對不對：

declare var jQuery: (selector: string) = > any;

jQuery('#foo');

declare 定義的類型只會用于編譯時的檢查，編譯結果中會被刪除。

上例的編譯結果是：

jQuery('#foo');

聲明文件

聲明文件以 .d.ts 為后綴，例如：

```
runoob.d.ts
```

聲明文件或模塊的語法格式如下：

```
declare module Module_Name {
}
```

TypeScript 引入聲明文件語法格式：

```
/// < reference path = " runoob.d.ts" / >
```

### 實例

以下定義一個第三方庫來演示：

## CalcThirdPartyJsLib.js 文件代碼：

```
var Runoob;  
(function(Runoob) {
    var Calc = (function () { 
        function Calc() { 
        } 
    })
    Calc.prototype.doSum = function (limit) {
        var sum = 0; 
 
        for (var i = 0; i <= limit; i++) { 
            sum = sum + i; 
        }
        return sum; 
    }
    Runoob.Calc = Calc; 
    return Calc; 
})(Runoob || (Runoob = {})); 
var test = new Runoob.Calc();
```

如果我們想在 TypeScript 中引用上面的代碼，則需要設置聲明文件 Calc.d.ts，代碼如下：

## Calc.d.ts 文件代碼：

```
declare module Runoob { 
   export class Calc { 
      doSum(limit:number) : number; 
   }
}
```

聲明文件不包含實現，它只是類型聲明，把聲明文件加入到 TypeScript 中：

## CalcTest.ts 文件代碼：

```
/// < reference path = "Calc.d.ts" / > 
var obj = new Runoob.Calc(); 
// obj.doSum("Hello"); // 編譯錯誤
console.log(obj.doSum(10));
```

下面這行導致編譯錯誤，因為我們需要傳入數字參數：

```
obj.doSum("Hello");
```

使用 tsc 命令來編譯以上代碼文件：

```
tsc CalcTest.ts
```

生成的 JavaScript 代碼如下：

## CalcTest.js 文件代碼：

```
/// < reference path = "Calc.d.ts" / > 
var obj = new Runoob.Calc();
//obj.doSum("Hello"); // 編譯錯誤
console.log(obj.doSum(10));
```

最后我們編寫一個 runoob.html 文件，引入 CalcTest.js 文件及第三方庫 CalcThirdPartyJsLib.js：

## 實例

```
< !DOCTYPE html >
< html >
< head >
< meta charset="utf-8" >
< title >菜鳥教程(runoob.com)< /title >
< script src = "CalcThirdPartyJsLib.js" >< /script > 
< script src = "CalcTest.js" >< /script > 
< /head >
< body >
    < h1 >聲明文件測試< /h1 >
    < p >菜鳥測試一下。< /p >
< /body >
< /html >
```

瀏覽器打開該文件輸出結果如下：

![image.png](//file1.elecfans.com/web2/M00/CF/B6/wKgZomYiFVmAMZ51AADjq9Vg5XI975.jpg)




審核編輯 黃宇