javascript - .d.ts 文件的构造和应用的简单示例？

Question

我正在阅读此文档，试图了解 TypeScript .d.ts 文件或声明文件的用途:

When using an external JavaScript library, or new host API, you’ll need to use a declaration file (.d.ts) to describe the shape of that library.

有人可以提供一个简单的例子来说明这意味着什么以及如何应用它吗？该文档做到了，但似乎有一种更简单的方法来解释它。例如，如果我想将 moment.js 与 TypeScript 一起使用，那么我将需要以下 momentjs.d.ts 文件...

但是为什么我需要这个文件？换句话说，为什么我不能在没有 *.d.ts 文件的情况下导入和使用 momentjs？

Answer 1

具体来说，您只需运行 typings install --global dt~moment(“从源 Definitely Typed 安装 moment 的全局声明文件”)。

您需要声明文件的原因是因为外部库可能不是用 typescript 编写的。因此，您必须定义库的 api 是什么样子，以便 typescript 大致知道可用的内容。

最简单的声明文件看起来像这样:

custom-typings/moment.d.ts

declare module 'moment'

这将允许您在任何需要的地方使用 moment 库，但是您将无法使用该库的任何功能使用任何多汁的自动完成或类型检查。但是，对外部模块进行类型检查非常有用，因为与您自己编写的代码相比，您可能对 API 不是很熟悉。