无法使用 typescript 开玩笑地模拟 fs - 类型上不存在属性“mockReturnValue”

Question

问题：

有人能帮我弄清楚如何使用 typescript 开玩笑地模拟 fs 吗？ 我已经尝试了一些东西，这是主要的：

我正在尝试使用 jest 来模拟“fs”，但我似乎无法开玩笑地自动模拟 Typescript 中的“fs”库。

这是我的代码：

import fs from 'fs';

jest.mock('fs');

describe('helloWorld.ts', () => {
  it('foobar', () => {

    fs.readdirSync.mockReturnValue(['foo.js', 'bar.js']);
  })
});

Typescript 告诉我“类型上不存在属性'mockReturnValue'......”

环境：

节点 v14.15.1
Typescript：“^4.0.3”
VS 代码 Typescript：4.1.2

在相关的说明中，我用 spyOn 尝试了这个，但失败了：

我尝试使用它，但也无法让spyOn工作（参考： jest typescript property mock does not exist on type ）

import fs from 'fs';

describe('helloWorld.ts', () => {
  it('foobar', () => {
    jest.spyOn(fs, 'readdirSync').mockImplementation(() => {
      return ['foo.js', 'bar.js'];
    });
    console.log(fs.readdirSync('.'));
  });
});

此代码失败，出现此 typescript 错误 TS2345：

Argument of type '() => string[]' is not assignable to parameter of type '(path: PathLike, options: BaseEncodingOptions & { withFileTypes: true; }) => Dirent[]'.
      Type 'string[]' is not assignable to type 'Dirent[]'.
        Type 'string' is not assignable to type 'Dirent'.

相关参考：

• 这似乎是相关的，但我觉得有一个更好的解决方案： Mock 'fs' module in jest
• 玩笑在这里有一个问题，表明 mocking 'fs' 应该在用jest.mock('fs') https://github.com/facebook/jest/issues/2258显式模拟时工作

Answer 1

TypeScript 编译器对fs是一个模拟一无所知。

您可以通过使用类型断言来告诉它：

(<jest.Mock>fs.readdirSync).mockReturnValue(...);

每次使用从fs模块导入的模拟函数时，都变得乏味。 为了使事情更简单，您可以声明一个类型为模块模拟的变量，用fs初始化它并在测试中使用它而不是fs ：

import fs from 'fs';

jest.mock('fs');

const mockFS: jest.Mocked<typeof fs> = <jest.Mocked<typeof fs>>fs;

describe('helloWorld.ts', () => {
  it('foobar', () => {

    mockFS.readdirSync.mockReturnValue(['foo.js', 'bar.js']);
  });
});