“声明文件”一节旨在教你如何编写高质量的 TypeScript 声明文件。在开始之前,我们需要假设你已基本熟悉 TypeScript 语言。
如果你还没有阅读过,建议先阅读 TypeScript 手册,以熟悉基本概念,尤其是类型和模块。
学习 .d.ts 文件工作原理的最常见场景是你正在为没有类型定义的 npm 包编写类型。在这种情况下,你可以直接跳到 模块 .d.ts。
“声明文件”部分分为以下几个章节。
声明参考
当我们手头只有底层库的示例代码作为参考时,往往不得不去编写声明文件。《声明参考》一节展示了许多常见的 API 模式,以及如何为每种模式编写声明。本指南面向那些可能尚不熟悉 TypeScript 中所有语言结构的初学者。
库结构
《库结构》指南旨在帮助你了解常见的库格式,以及如何为每种格式编写规范的声明文件。如果你只是在编辑一个现有的文件,可能无需阅读此章节。我们强烈建议新的声明文件作者阅读此章节,以正确理解库的格式如何影响声明文件的编写。
在“模板”一节中,你将找到一些声明文件,它们可以作为编写新文件时的有用起点。如果你已经了解了你的库结构,请查看侧边栏中的“d.ts 模板”部分。
最佳实践 (Do's and Don'ts)
声明文件中许多常见的错误是可以轻松避免的。《最佳实践》一节指出了这些常见错误,描述了如何识别它们,以及如何修复它们。每个人都应该阅读这一节,以帮助自己规避常见问题。
深入探讨
对于想要了解声明文件底层工作机制的资深作者,《深入探讨》一节解释了声明编写中的许多高级概念,并展示了如何利用这些概念来创建更简洁、更直观的声明文件。
发布到 npm
《发布》一节解释了如何将你的声明文件发布到 npm 包中,并展示了如何管理你的依赖包。
查找并安装声明文件
对于 JavaScript 库的用户,《使用》一节提供了几个简单的步骤来定位并安装相应的声明文件。