Typescript 期望 mockImplementation 为所有方法和属性提供模拟

Posted 2023-03-13

【中文标题】Typescript 期望 mockImplementation 为所有方法和属性提供模拟

【英文标题】：Typescript expects mockImplementation to supply mocks for all methods and properties

【发布时间】：2020-06-09 11:32:43

【问题描述】：

我正在使用 typescript + jest，并且在创建模拟实现时遇到了一些类型检查问题。例如，我想从aws-sdk 模拟Credentials 对象：

import  Credentials  from "aws-sdk";

jest.mock("aws-sdk");

const CredentialsMock = mocked(Credentials);

describe("Foo test", () => 
  beforeAll(() => 
    CredentialsMock.mockImplementation(() =>  /*** <--- Type checking fails here ***/
      return 
        get: jest.fn()
      
    );
  );
);

我遇到的问题是，当我只想模拟一个方法时，类型检查器希望我为 Credentials 类型的每个方法/属性提供模拟。具体错误是：

TS2345: '() 类型的参数 => get: jest.Mock; ' 不能分配给类型为 '(accessKeyId: string, secretAccessKey: string, sessionToken?: string | undefined) => Credentials'的参数。

输入 ' 获取：模拟； ' 缺少“凭据”类型的以下属性：getPromise、needsRefresh、refresh、refreshPromise 和另外 5 个。

有没有办法让打字稿在这里快乐？

【参考方案1】：

当提供与原始参数或返回值不同的模拟实施时，我发现让 typescript 满意的一种方法是将模拟实例包装在 type assertion 中。假设您的示例中的mocked(Credentials) 返回jest.MockInstance，则类型断言将如下所示：

    (CredentialsMock as jest.MockInstance<any, any>).mockImplementation(() => 
      return 
        get: jest.fn()
      
    );