如何創(chuàng)建高質(zhì)量的TypeScript聲明文件(二)

轉(zhuǎn)載 ## 如何創(chuàng)建高質(zhì)量的TypeScript聲明文件(二)

繼續(xù)上篇文章[如何創(chuàng)建高質(zhì)量的TypeScript聲明文件(一)]

模塊化庫

有些庫只能在模塊加載器環(huán)境中工作凹蜂。 例如症杏,因為express僅適用于Node.js倍宾,必須使用CommonJS require函數(shù)加載。

ECMAScript 2015(也稱為ES2015捌袜,ECMAScript 6和ES6),CommonJS和RequireJS具有類似的導(dǎo)入模塊的概念。 例如勿她,在JavaScript CommonJS(Node.js)中即横,您可以編寫

var fs = require("fs");

在TypeScript或ES6中噪生,import關(guān)鍵字用于相同的目的:

import fs = require("fs");

您通常會看到模塊化庫在其文檔中包含以下行之一:

var someLib = require('someLib');

define(..., ['someLib'], function(someLib) {

});

與全局模塊一樣,您可能會在UMD模塊的文檔中看到這些示例东囚,因此請務(wù)必查看代碼或文檔跺嗽。

從代碼中識別模塊庫

模塊化庫通常至少具有以下某些功能:

  • 無條件調(diào)用require或define
  • import * as a from 'b'的聲明,或export c;
  • 對exports或module.exports的賦值

他們很少會:

  • 分配window或global的屬性

模塊化庫的示例

許多流行的Node.js庫都在模塊系列中页藻,例如express桨嫁,gulp和request。

UMD

UMD模塊可以用作模塊(通過導(dǎo)入)份帐,也可以用作全局模塊(在沒有模塊加載器的環(huán)境中運行)璃吧。 許多流行的庫,如Moment.js废境,都是以這種方式編寫的畜挨。 例如筒繁,在Node.js中或使用RequireJS,您可以編寫:

import moment = require("moment");
console.log(moment.format());

而在vanilla瀏覽器環(huán)境中巴元,你會寫:

console.log(moment.format());

識別UMD庫

UMD模塊檢查是否存在模塊加載器環(huán)境毡咏。 這是一個易于查看的模式,看起來像這樣:

(function (root, factory) {
    if (typeof define === "function" && define.amd) {
        define(["libName"], factory);
    } else if (typeof module === "object" && module.exports) {
        module.exports = factory(require("libName"));
    } else {
        root.returnExports = factory(root.libName);
    }
}(this, function (b) {

如果您在庫的代碼中看到typeof define务冕,typeof window或typeof module的測試血当,特別是在文件的頂部,它幾乎總是一個UMD庫禀忆。

UMD庫的文檔通常還會演示一個"Using in Node.js"示例臊旭,其中顯示了require,以及一個"Using in the browser"示例箩退,該示例顯示了使用<script>標(biāo)記加載腳本离熏。

UMD庫的示例

大多數(shù)流行的庫現(xiàn)在都可以作為UMD包使用。 示例包括jQuery戴涝,Moment.js滋戳,lodash等等。

模板

模塊有三個模板啥刻,module.d.ts奸鸯,module-class.d.ts和module-function.d.ts。

如果您的模塊可以像函數(shù)一樣被調(diào)用可帽,請使用module-function.d.ts:

var x = require("foo");
// Note: calling 'x' as a function
var y = x(42);

請務(wù)必閱讀腳注"ES6對模塊調(diào)用簽名的影響"

如果您的模塊可以使用new構(gòu)建娄涩,請使用module-class.d.ts:

var x = require("bar");
// Note: using 'new' operator on the imported variable
var y = new x("hello");

同樣的腳注適用于這些模塊。

如果您的模塊不可調(diào)用或可構(gòu)造映跟,請使用module.d.ts文件蓄拣。

未完待續(xù)...

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市努隙,隨后出現(xiàn)的幾起案子球恤,更是在濱河造成了極大的恐慌,老刑警劉巖荸镊,帶你破解...
    沈念sama閱讀 218,284評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件咽斧,死亡現(xiàn)場離奇詭異,居然都是意外死亡躬存,警方通過查閱死者的電腦和手機(jī)收厨,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,115評論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來优构,“玉大人诵叁,你說我怎么就攤上這事∏胀郑” “怎么了拧额?”我有些...
    開封第一講書人閱讀 164,614評論 0 354
  • 文/不壞的土叔 我叫張陵碑诉,是天一觀的道長。 經(jīng)常有香客問我侥锦,道長进栽,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,671評論 1 293
  • 正文 為了忘掉前任恭垦,我火速辦了婚禮快毛,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘番挺。我一直安慰自己唠帝,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,699評論 6 392
  • 文/花漫 我一把揭開白布玄柏。 她就那樣靜靜地躺著襟衰,像睡著了一般。 火紅的嫁衣襯著肌膚如雪粪摘。 梳的紋絲不亂的頭發(fā)上瀑晒,一...
    開封第一講書人閱讀 51,562評論 1 305
  • 那天,我揣著相機(jī)與錄音徘意,去河邊找鬼苔悦。 笑死,一個胖子當(dāng)著我的面吹牛椎咧,可吹牛的內(nèi)容都是我干的玖详。 我是一名探鬼主播,決...
    沈念sama閱讀 40,309評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼邑退,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了劳澄?” 一聲冷哼從身側(cè)響起地技,我...
    開封第一講書人閱讀 39,223評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎秒拔,沒想到半個月后莫矗,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,668評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡砂缩,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,859評論 3 336
  • 正文 我和宋清朗相戀三年作谚,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片庵芭。...
    茶點故事閱讀 39,981評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡妹懒,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出双吆,到底是詐尸還是另有隱情眨唬,我是刑警寧澤会前,帶...
    沈念sama閱讀 35,705評論 5 347
  • 正文 年R本政府宣布,位于F島的核電站匾竿,受9級特大地震影響瓦宜,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜岭妖,卻給世界環(huán)境...
    茶點故事閱讀 41,310評論 3 330
  • 文/蒙蒙 一临庇、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧昵慌,春花似錦假夺、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,904評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至蜻韭,卻和暖如春悼尾,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背肖方。 一陣腳步聲響...
    開封第一講書人閱讀 33,023評論 1 270
  • 我被黑心中介騙來泰國打工闺魏, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人俯画。 一個月前我還...
    沈念sama閱讀 48,146評論 3 370
  • 正文 我出身青樓析桥,卻偏偏與公主長得像,于是被迫代替她去往敵國和親艰垂。 傳聞我的和親對象是個殘疾皇子泡仗,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,933評論 2 355

推薦閱讀更多精彩內(nèi)容