Namespace mockApis

Remarks

There are some variations among the APIs depending on what needs tests might have, but overall there are three main usage patterns:

1: Creating an actual fake API instance, often with a simplified version of functionality, by calling the mock API itself as a function.

// The function often accepts parameters that control its behavior
const foo = mockApis.foo();
Copy

2: Creating a mock API, where all methods are replaced with jest mocks, by calling the API's mock function.

// You can optionally supply a subset of its methods to implement
const foo = mockApis.foo.mock({
  someMethod: () => 'mocked result',
});
// After exercising your test, you can make assertions on the mock:
expect(foo.someMethod).toHaveBeenCalledTimes(2);
expect(foo.otherMethod).toHaveBeenCalledWith(testData);
Copy

3: Creating an API factory that behaves similarly to the mock as per above.

const factory = mockApis.foo.factory({
  someMethod: () => 'mocked result',
});
Copy