TypeScript 作為 JavaScript 的超集,在開發過程中不可避免要引用其他第三方的 JavaScript 的庫。
雖然通過直接引用可以調用庫的類和方法,但是卻無法使用TypeScript 諸如類型檢查等特性功能。
為了解決這個問題,需要将這些庫裡的函數和方法體去掉後隻保留導出類型聲明,而産生了一個描述 JavaScript 庫和子產品資訊的聲明檔案。
通過引用這個聲明檔案,就可以借用 TypeScript 的各種特性來使用庫檔案了。
一、declare 關鍵字
假如我們想使用第三方庫,比如 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 引入聲明檔案文法格式:
///
當然,很多流行的第三方庫的聲明檔案不需要我們定義了,比如 jQuery 已經有人幫我們定義好了:jQuery in DefinitelyTyped。
執行個體
以下定義一個第三方庫來示範:
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 檔案代碼:
///
var obj = new Runoob.Calc();
// obj.doSum("Hello"); // 編譯錯誤
console.log(obj.doSum(10));
下面這行導緻編譯錯誤,因為我們需要傳入數字參數:
obj.doSum("Hello");
使用 tsc 指令來編譯以上代碼檔案:
tsc CalcTest.ts
生成的 JavaScript 代碼如下:
CalcTest.js 檔案代碼:
///
var obj = new Runoob.Calc();
//obj.doSum("Hello"); // 編譯錯誤
console.log(obj.doSum(10));
</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>