無法使用 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']);
  });
});