Skip to content
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待
虚位以待

引言

声明文件部分旨在教你如何编写高质量的 TypeScript 声明文件。在开始之前,我们假设你对 TypeScript 语言有基本的了解。

如果你还没有,应该阅读 TypeScript 手册 来熟悉基本概念,特别是类型和模块。

学习 .d.ts 文件如何工作的最常见场景是,你正在为一个没有类型的 npm 包编写类型定义。在这种情况下,你可以直接跳转到 模块 .d.ts

声明文件部分分为以下几个小节。

声明参考

当我们只有底层库的示例作为指导时,常常需要编写声明文件。声明参考 部分展示了许多常见的 API 模式,以及如何为每种模式编写声明。本指南面向 TypeScript 新手,他们可能还不熟悉 TypeScript 中的每种语言结构。

库结构

库结构 指南帮助你理解常见的库格式,以及如何为每种格式编写正确的声明文件。如果你正在编辑一个现有文件,可能不需要阅读本节。强烈建议新声明文件的作者阅读本节,以正确理解库的格式如何影响声明文件的编写。

在模板部分,你会发现一些声明文件,它们在编写新文件时可以作为有用的起点。如果你已经知道你的结构,请查看侧边栏中的 d.ts 模板部分。

注意事项

声明文件中的许多常见错误都可以轻松避免。注意事项 部分指出了常见错误,描述了如何发现它们以及如何修复它们。每个人都应该阅读本节,以帮助自己避免常见错误。

深入探究

对于有兴趣了解声明文件底层机制的经验丰富的作者,深入探究 部分解释了声明编写中的许多高级概念,并展示了如何利用这些概念创建更清晰、更直观的声明文件。

发布到 npm

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

查找和安装声明文件

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