介绍

声明文件部分旨在教您如何编写高质量的 TypeScript 声明文件。我们需要假设基本熟悉 TypeScript 语言才能开始。

如果您还没有,您应该阅读 TypeScript 手册 以熟悉基本概念,尤其是类型和模块。

了解 .d.ts 文件如何工作的最常见情况是您正在键入一个没有类型的 npm 包。在这种情况下,您可以直接跳转到 模块 .d.ts

声明文件部分分为以下部分。

声明参考手册

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

库结构

5KGRmROVAwwpE9QqNN/XgpiQv7y01kn7+6HeLhdcTAPZtE2VmHkHsQUJC3WmMKWM1OisXDhTkfoi1EGgLp191Ire8bKu0GlwJtzYxvXryUBqDqswZQgU5JzDh3ham+ROYe5MjjNtfqVqrSqTQlIox4x4GEHLJz9p9iDGqBmGEcBe047Nj1xGHl26qhoROlDvUPtDGrqBz0Oz3U0MagmGNhIkkwGZIhcm+po5cvtDDie2akwrl6KhIRbkVmGCrmygTkP+DPe7LEFMyn28wt6zHQqzAqqnEQTaKu0j8Ew5JkNY/gsgZTg4YcAVAaAnJ5+wXKa/piZ2ltw+wWJ5B7Z6omVArKOQEk+28H5WliHVXanWalAa1sGL+VpUpQn9puUk/K5Gt6GOR2Ar3pcdc8fgcd4HxlILfU3UCJt2zYo6MxdY8cEuVA/GHSAELuGDXMhGKllrJYaMi0rpjJHx++SEig==

xY93oTfKyHhgnaj4UWNsD9Rr1I1ldGenlokhjcBvnQzPvwd4R/48XbtRZGkcR92Nfham/ix0svuHYAUvRrU+S01tB4W5qMz/qVBcSItyJ2zzoOzanDd09/4GIu78mnjjqMEUE5/DHn2ntuZwMu58KvoAKtU7jYU94seI3z4xk+p5IXwumzhZo/FBPO2idLKtNharI8N9n4UpfR7Y6f/T6fNVnXtFu+fuZmoCRblMfc98HhTI6hZw/n5r8c8GhRWj

该做什么和不该做什么

Bi/K4i1n5hmB9u0VU+MrYQmenQjE5L/wdwwB4X6LAsC/mzbuuGturp4JiaYllSQEfCGvFI2KQFff6AWlb6seh6HoFkZr3GgW+hIoP9DhbUQWEr2BpjCkqLEzchspE4Sym9odPnOWp8hjwCSlsEV7liNxsu5Y6zwWkJS+TZi6Pl2ZomhYock9AWSywlrH7y3uu8U24n70Ohy40blk7xbQ8OmiSFoa3cr4pn3jCoG2s7Y+3xNPeCDCQO4ThwUyX3ncvtGURGaHT1tQSbfx6cCgqi1rkQjlGfyypSj3aMmf22lT92hkhHmcpjlDMaj4FquqN3HqwsYYt808txsYwcEHTjqGQxDkd5GpXC7Gwecimc9loav+Rpe6Ku2Pc+Y/sRbQ

深入探讨

aJXOFVw4ibrgoVF20u8rrYpQrPAQsM1pzHUR/wngPC0IK7fj3GgPZ7JKkdwaBRdOn3WsrR/MTLSEOxYIFWuiERf35miGOaAMiBDkOmz5cfu+VFNJiVp2n8G9LoQHqvqSYYbw87kW+4dAb7zo8WjDJcWM1LbeLqrHXiHpgweEeSPPGDG8cT1yNCIz1nQd9XXA4vNauyXY9vTzOsTpuOtOvXEXUxL4S28S9CvP7s5UeHQxyoXs3nVif++aSiAAiKS7Zy60uWnSOnTTov0p3HTG7cd5CRvER13z9wOSFU7bkdi/YMP9vGWjDi4e8VAUHBM7eBZrSmGSogsykr5uOSBioMA+vHRY3015XB1jETRm0YP1bLqPEbeArEmyUs6lYYmV

发布到 npm

WcHjQmKnJ6nyGrU5OThfx2IJInle/b9EIxRK+jiVQrmkQTReEF/mTBOp5jYbRgjeg/9bU2FjR1vUnOm/JZ3M+C18JamGylBi5xJ92aBaK+0lF0cq1F9AraigEZUtT5eEDsg6hJ16/pURWLIN1jzrXxT39ZA3HcP3jQWOTtDl1+i4Pz7bOGyR3gfmNc1V2d//XJlAtLqCPe6S3qH4LF9fEQ==

查找并安装声明文件

yNPHRGulPMp8vgPYxNi2EELMuE7u1pa9cUIjkDnYL22xCZaYTDSIj6sFYodVuq6aQZc6FeJjtPnAD9w2dUGoRpjFsScfMnjoJq/I/FNSO9o3G/Cai668hHtcbIfTFUf3izCQ2RrKjev4zm/8TmGHOyxmeswU/0GbVibx87qJbEyt8Al+he9BA557e5ZlW9tifP7eb6CIyD3wvGAKmvtL3/5a9V0mVf8+lWoqgPLzTLc=