通过模块扩充向现有 TypeScript 接口添加属性无效

Question

我有一个依赖于@types/hapi 的 Node 应用程序。我想向此模块中定义的类之一添加一个属性。我尝试通过模块扩充来定义我的新属性：

// my-custom-hapi-typings.d.ts
import * as hapi from 'hapi';

declare module hapi {
    interface Server {
        myProperty: string;
    }
}

这不会导致任何编译器错误，但也不会将myProperty 属性添加到Server 类。当我尝试像这样引用该属性时，我仍然在项目的其他地方遇到错误：

// my-other-file.ts
import * as hapi from 'hapi';

const server = new hapi.Server({ ... });

// error: Property 'myProperty' does not exist on type 'Server'.
server.myProperty = 'hello'; 

为什么 TypeScript 编译器似乎忽略了我的 .d.ts 文件？我是否需要“导入”文件或以某种方式让 TypeScript 编译器知道该文件存在？我的印象是，只需在源目录中放置一个 .d.ts 文件就足以让 TypeScript 接受这些增强。

Answer 1

这是你的问题：

declare module hapi {

这实际上是在定义一个namespace，使用早于 ES6 模块的旧语法，这些模块曾经被称为“内部模块”。编写module hapi 与编写namespace hapi 相同，这是当今的首选语法。 More on namespaces vs modules here.

对于declare an external module，您只需将模块名称放在引号中即可：

[...] 使用类似于环境命名空间的构造，但我们使用module 关键字和引用的模块名称，这些模块将可用于以后的导入。

换句话说，只需将hapi 放在引号中：

declare module "hapi"

现在你有一个环境（my-custom-hapi-typings.d.ts不需要直接导入）外部模块定义（声明import "hapi"给你什么），你可以扩充里面声明的内容。

如果您将鼠标悬停在 module hapi 和 module "hapi" in the Playground 上，您会在工具提示中看到不同之处：

是的，由于其背后的历史，它是微妙而令人困惑的。