宣告檔案區段旨在教導您如何撰寫高品質的 TypeScript 宣告檔案。我們需要假設您基本熟悉 TypeScript 語言才能開始。
如果您尚未閱讀,您應該閱讀 TypeScript 手冊 以熟悉基本概念,特別是類型和模組。
學習 .d.ts 檔案運作方式最常見的情況是,您正在輸入沒有類型的 npm 套件。在這種情況下,您可以直接跳到 模組 .d.ts。
宣告檔案區段分為以下各區段。
宣告參考
當我們只有底層函式庫的範例可供參考時,我們經常會面臨撰寫宣告檔的問題。宣告參考部分顯示許多常見的 API 模式,以及如何為每個模式撰寫宣告。本指南的目標讀者是 TypeScript 新手,他們可能還不熟悉 TypeScript 中的每個語言建構。
函式庫結構
函式庫結構指南可協助您了解常見的函式庫格式,以及如何為每個格式撰寫適當的宣告檔。如果您正在編輯現有的檔案,您可能不需要閱讀本部分。強烈建議撰寫新宣告檔的作者閱讀本部分,以正確了解函式庫的格式如何影響宣告檔的撰寫。
在範本部分,您會找到許多宣告檔,這些宣告檔可作為撰寫新檔案時有用的起點。如果您已經知道自己的結構,請參閱側邊欄中的 d.ts 範本部分。
注意事項
許多宣告檔案中的常見錯誤可以輕易避免。注意事項區段會找出常見錯誤,說明如何偵測這些錯誤,以及如何修正這些錯誤。每個人都應該閱讀此區段,以幫助自己避免常見錯誤。
深入探討
對於有興趣了解宣告檔案運作基礎機制的資深作者,深入探討區段會說明宣告撰寫中的許多進階概念,並展示如何運用這些概念來建立更簡潔且更直覺的宣告檔案。
發佈到 npm
發佈區段會說明如何將您的宣告檔案發佈到 npm 套件,並展示如何管理您的相依套件。
尋找並安裝宣告檔案
對於 JavaScript 函式庫使用者,使用 區段提供幾個簡單的步驟來尋找並安裝對應的宣告檔案。