“宣告檔案”一節旨在教你如何編寫高質量的 TypeScript 宣告檔案。在開始之前,我們需要假設你已基本熟悉 TypeScript 語言。
如果你還沒有閱讀過,建議先閱讀 TypeScript 手冊,以熟悉基本概念,尤其是型別和模組。
學習 .d.ts 檔案工作原理的最常見場景是你正在為沒有型別定義的 npm 包編寫型別。在這種情況下,你可以直接跳到 模組 .d.ts。
“宣告檔案”部分分為以下幾個章節。
宣告參考
當我們手頭只有底層庫的示例程式碼作為參考時,往往不得不去編寫宣告檔案。《宣告參考》一節展示了許多常見的 API 模式,以及如何為每種模式編寫宣告。本指南面向那些可能尚不熟悉 TypeScript 中所有語言結構的初學者。
庫結構
《庫結構》指南旨在幫助你瞭解常見的庫格式,以及如何為每種格式編寫規範的宣告檔案。如果你只是在編輯一個現有的檔案,可能無需閱讀此章節。我們強烈建議新的宣告檔案作者閱讀此章節,以正確理解庫的格式如何影響宣告檔案的編寫。
在“模板”一節中,你將找到一些宣告檔案,它們可以作為編寫新檔案時的有用起點。如果你已經瞭解了你的庫結構,請檢視側邊欄中的“d.ts 模板”部分。
最佳實踐 (Do's and Don'ts)
宣告檔案中許多常見的錯誤是可以輕鬆避免的。《最佳實踐》一節指出了這些常見錯誤,描述瞭如何識別它們,以及如何修復它們。每個人都應該閱讀這一節,以幫助自己規避常見問題。
深入探討
對於想要了解宣告檔案底層工作機制的資深作者,《深入探討》一節解釋了宣告編寫中的許多高階概念,並展示瞭如何利用這些概念來建立更簡潔、更直觀的宣告檔案。
釋出到 npm
《釋出》一節解釋瞭如何將你的宣告檔案釋出到 npm 包中,並展示瞭如何管理你的依賴包。
查詢並安裝宣告檔案
對於 JavaScript 庫的使用者,《使用》一節提供了幾個簡單的步驟來定位並安裝相應的宣告檔案。