声明文件部分旨在教你如何编写高质量的 TypeScript 声明文件。为了开始,我们需要假设你对 TypeScript 语言有一定的基本了解。
如果你还没有,你应该阅读 TypeScript 手册,熟悉基本概念,特别是类型和模块。
学习 .d.ts 文件工作原理最常见的情况是,您正在键入一个没有类型的 npm 包。在这种情况下,您可以直接跳转到 模块 .d.ts。
声明文件部分分为以下几节。
声明参考
我们经常需要编写声明文件,而我们只有底层库的示例来指导我们。 声明参考 部分展示了许多常见的 API 模式以及如何为每个模式编写声明。本指南针对 TypeScript 新手,他们可能还不熟悉 TypeScript 中的每种语言结构。
库结构
库结构 指南帮助您了解常见的库格式以及如何为每种格式编写正确的声明文件。如果您正在编辑现有文件,您可能不需要阅读本节。强烈建议新声明文件作者阅读本节,以正确了解库的格式如何影响声明文件的编写。
在模板部分,您会找到一些声明文件,它们可以作为编写新文件时的有用起点。如果您已经知道您的结构是什么,请参阅侧边栏中的 d.ts 模板部分。
常见错误及解决方法
许多常见的声明文件错误可以轻松避免。在 常见错误及解决方法 部分中,我们识别了常见的错误,并描述了如何检测和修复它们。每个人都应该阅读本节,以帮助自己避免常见的错误。
深入探讨
对于有经验的作者,如果您对声明文件的工作原理感兴趣,深入探讨 部分解释了声明编写中的许多高级概念,并展示了如何利用这些概念来创建更简洁、更直观的声明文件。
发布到 npm
在 发布到 npm 部分中,我们解释了如何将您的声明文件发布到 npm 包,并展示了如何管理您的依赖包。
查找并安装声明文件
对于 JavaScript 库用户,使用 部分提供了一些简单步骤来查找和安装相应的声明文件。