jest/prefer-jest-mocked 樣式

🛠️ 此規則的部分違規行為可進行自動修正。

此規則的作用

當使用 Jest 模擬函數時，建議使用 jest.mocked() 輔助函式來正確鍵入模擬函數。此規則強制使用 jest.mocked() 以獲得更好的型別安全性和可讀性。

受限型別

• jest.Mock
• jest.MockedFunction
• jest.MockedClass
• jest.MockedObject

範例

// invalid
(foo as jest.Mock).mockReturnValue(1);
const mock = (foo as jest.Mock).mockReturnValue(1);
(foo as unknown as jest.Mock).mockReturnValue(1);
(Obj.foo as jest.Mock).mockReturnValue(1);
([].foo as jest.Mock).mockReturnValue(1);

// valid
jest.mocked(foo).mockReturnValue(1);
const mock = jest.mocked(foo).mockReturnValue(1);
jest.mocked(Obj.foo).mockReturnValue(1);
jest.mocked([].foo).mockReturnValue(1);

參考資料

• 規則來源