TypeScript 聲明文件介紹

這篇指南的目的是教你如何書寫高質(zhì)量的TypeScript聲明文件。

在這篇指南里，我們假設(shè)你對TypeScript已經(jīng)有了基本的了解。 如果沒有，請先閱讀 TypeScript手冊 來了解一些基本知識，尤其是類型和命名空間部分。

章節(jié)

這篇指南被分成了以下章節(jié)。

結(jié)構(gòu)

結(jié)構(gòu)一節(jié)將幫助你了解常見庫的格式以及如何為每種格式書寫正確的聲明文件。 如果你在編輯一個(gè)已經(jīng)存在的文件，那么你可能不需要閱讀此章節(jié)。 如果你在書寫新的聲明文件，那么你必須閱讀此章節(jié)以理解庫的不同格式是如何影響聲明文件的書寫的。

規(guī)范

聲明文件里有很多常見的錯(cuò)誤是很容易避免的。規(guī)范一節(jié)指出了常見的錯(cuò)誤， 描述了如何發(fā)現(xiàn)它們， 與怎樣去修復(fù)。 每個(gè)人都要閱讀這個(gè)章節(jié)以了解如何避免常見錯(cuò)誤。

舉例

很多時(shí)候，我們只能通過一些示例來了解第三方庫是如何工作的，同時(shí)我們需要為這樣的庫書寫聲明文件。舉例一節(jié)展示了很多常見的API模式以及如何為它們書寫聲明文件。 這篇指南是針對TypeScript初學(xué)者的，他們可能還不了解TypeScript里的所有語言結(jié)構(gòu)。

深入

對于那些對聲明文件底層工作機(jī)制感興趣的老手們，深入一節(jié)解釋了很多高級書寫聲明文件的高級概念， 以及展示了如何利用這些概念來創(chuàng)建整潔和直觀的聲明文件。

模版

在模版一節(jié)里，你能找到一些聲明文件，它們可以幫助你快速開始 當(dāng)你在書寫一個(gè)新聲明文件的時(shí)候。 參考結(jié)構(gòu)這篇文檔來找到應(yīng)該使用哪個(gè)模版文件。

發(fā)布到npm

發(fā)布一節(jié)講解了如何發(fā)布聲明文件為npm包，及如何管理包的依賴。

查找與安裝聲明文件

對于JavaScript庫的使用者來講，使用一節(jié)提供了一些簡單步驟來定位與安裝相應(yīng)的聲明文件。