Introduction

介绍

本指南旨在教您如何编写高质量的TypeScript声明文件。

在本指南中，我们将假定对TypeScript语言基本熟悉。如果你还没有，你应该阅读TypeScript手册来熟悉基本概念，特别是类型和命名空间。

该指南分为以下几部分。

“库结构”指南可帮助您了解常用库格式以及如何为每种格式编写正确的声明文件。如果您正在编辑现有文件，则可能不需要阅读本节。新声明文件的作者必须阅读本节以正确理解库的格式如何影响声明文件的写入。

声明文件中的许多常见错误都可以轻松避免。Do's和Don'ts部分标识常见错误，描述如何检测它们以及如何解决它们。每个人都应该阅读本节以帮助自己避免常见错误。

很多时候，当我们只有基础库的例子来指导我们时，我们正面临着写一个声明文件。By Example部分显示了许多常见的API模式以及如何为每个模式编写声明。本指南针对TypeScript新手，他们可能还不熟悉TypeScript中的每种语言结构。

对于声明文件如何工作的基础机制感兴趣的经验丰富的作者，Deep Dive部分介绍了声明编写中的许多高级概念，并展示了如何利用这些概念创建更清晰，更直观的声明文件。

在模板中，您可以找到许多声明文件，这些文件在编写新文件时可作为有用的起点。请参阅库结构中的文档以确定要使用的模板文件。

发布部分解释了如何将您的声明文件发布到npm包，并演示如何管理您的依赖包。

对于JavaScript库用户，消费部分提供了几个简单的步骤来定位和安装相应的声明文件。