node.js - 我可以使用自定义模块解析函数(如 "proxyquire")代替 TypeScript 的 require() 吗？

Question

我有一个 TypeScript 文件 config.ts 将与 Node 一起运行:

import myDependency = require('my-dependency');    

export = {
    doSomething = () => {
        ...
    }
}

在其他 TypeScript 文件中，我可以导入具有完全类型安全的此文件:

import config = require('./config');
config.doSomething();
config.doSomethingElse(); // compiler error, this method doesn't exist

现在我想对这个脚本进行单元测试。为了模拟此脚本 require() 的依赖关系，我正在使用 proxyquire ，这让我可以提供我的脚本在调用 require() 时将获得的值。我的测试可能如下所示:

import proxyquire = require('proxyquire');
const config = proxyquire('./config', {
    'my-dependency': {} // this mocked object will be provided when config.ts asks for `my-dependency`
});

expect(config.doSomething()).to.do.something();

这工作正常，除了我的 config 变量是 any 类型，因为我使用 proxyquire() 代替 要求()。 TypeScript 必须对 require() 函数给予特殊处理，以允许它执行模块解析。有没有办法告诉 TypeScript 编译器 proxyquire() 也应该进行模块解析，类似于 require()？

我可以将 config.ts 重写为类或使其使用接口(interface)。然后我将能够通过导入类/接口(interface)定义在我的测试中显式键入变量。但是允许 proxyquire() 为我隐式输入内容将是更简单的解决方案。

Answer 1

有一个解决方法 - 您可以通过导入实际模块并在类型转换中使用 typeof 来获取 config.ts 模块的类型:

import proxyquire = require('proxyquire');

import configType = require('./config');

const config = <typeof configType> proxyquire('./config', {
    'my-dependency': {} // this mocked object will be provided when config.ts asks for `my-dependency`
});

config.doSomething();

// config.noSuchMethod(); // does not compile

这并不理想，因为您必须在测试中导入同一个模块两次 - 真正的模块只是为了了解它的类型，而“近似”模块是为了在您的测试中实际使用，而且您必须小心不要混淆两者。但与为 typescript 实现模块解析的另一种变体的任务相比，它非常简单。此外，当以这种方式使用 configType 时 - 仅用于输入 - 它的导入甚至不会出现在生成的 javacsript 代码中。