1. 程式人生 > 其它 >TypeScript學習(三)宣告檔案&declare關鍵字

TypeScript學習(三)宣告檔案&declare關鍵字

前言

TypeScript 作為 JavaScript 的超集,在開發過程中不可避免要引用其他第三方的 JavaScript 的庫。雖然通過直接引用可以呼叫庫的類和方法,但是卻無法使用TypeScript 諸如型別檢查等特性功能。為了解決這個問題,需要將這些庫裡的函式和方法體去掉後只保留匯出型別宣告,而產生了一個描述 JavaScript 庫和模組資訊的宣告檔案。通過引用這個宣告檔案,就可以借用 TypeScript 的各種特性來使用庫檔案了。

假如我們想使用第三方庫,比如 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" />

當然,很多流行的第三方庫的宣告檔案不需要我們定義了,比如 jQuery 已經有人幫我們定義好了

例項

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

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();

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></title>
<script src = "CalcThirdPartyJsLib.js"></script> 
<script src = "CalcTest.js"></script> 
</head>
<body>
    <h1>宣告檔案測試</h1>
    <p>測試一下。</p>
</body>
</html>

declare關鍵字

在編寫宣告檔案(.d.ts)時,declare表示宣告作用。

細節參考:https://www.tslang.cn/docs/handbook/declaration-files/by-example.html