Fix toHaveBeenCalledBefore/toHaveBeenCalledAfter type definition

[aheuermann]

What

I get a compiler error when passing a jest.MockedFunction type to toHaveBeenCalledAfter()/toHaveBeenCalledBefore().

Why

Code showing the issue.

import { func } from './some-func';
import { SomeClass } from './some-class';

const mockFunc = func as jest.MockedFunction<typeof func>;
const mockClass = SomeClass as jest.MockedClass<typeof SomeClass>;

jest.mock('./some-func');
jest.mock('./some-class');

// all of the following statements generate a compiler error
expect(jest.fn()).toHaveBeenCalledBefore(mockFunc);
expect(jest.fn()).toHaveBeenCalledBefore(mockClass);
expect(jest.fn()).toHaveBeenCalledAfter(mockFunc);
expect(jest.fn()).toHaveBeenCalledAfter(mockClass);

I get this compiler error.

 Argument of type 'MockedFunction<() => void>' is not assignable to parameter of type 'Mock<any, any>'.
  The types returned by 'mockClear().mockClear()' are incompatible between these types.
    Type 'MockedFunction<() => void>' is not assignable to type 'Mock<any, any>'.
      Type 'MockInstance<void, [()?]> & (() => void)' provides no match for the signature 'new (...args: any): any'.

12. expect(jest.fn()).toHaveBeenCalledAfter(mockFunc);

Changing these to jest.MockInstance resolves the issue and should work for all use cases as both jest.MockedFunction and jest.MockedClass extend jest.MockInstance.

Notes

Housekeeping

• Unit tests
• Documentation is up to date
• No additional lint warnings
• Typescript definitions are added/updated where relevant

[jacksteamdev]

Until this gets merged, you can fix this in your own project by adding the following to a declaration file (modules.d.ts or maybe jest-extended.d.ts) to your own project.

/// <reference types="jest" />

declare namespace jest {
  interface Matchers {
    /**
     * Use `.toHaveBeenCalledBefore` when checking if a `MockInstance` was called before another `MockInstance`.
     *
     * Note: Required Jest version >=23
     *
     * @param {MockInstance} mock
     */
    toHaveBeenCalledBefore(mock: jest.MockInstance): R

    /**
     * Use `.toHaveBeenCalledAfter` when checking if a `MockInstance` was called after another `MockInstance`.
     *
     * Note: Required Jest version >=23
     *
     * @param {MockInstance} mock
     */
    toHaveBeenCalledAfter(mock: jest.MockInstance): R
  }

  interface Expect {
    /**
     * Use `.toHaveBeenCalledBefore` when checking if a `MockInstance` was called before another `MockInstance`.
     *
     * Note: Required Jest version >=23
     *
     * @param {MockInstance} mock
     */
    toHaveBeenCalledBefore(mock: jest.MockInstance): R

    /**
     * Use `.toHaveBeenCalledAfter` when checking if a `MockInstance` was called after another `MockInstance`.
     *
     * Note: Required Jest version >=23
     *
     * @param {MockInstance} mock
     */
    toHaveBeenCalledAfter(mock: jest.MockInstance): R
  }
}

[codecov]

Codecov Report

Merging #292 (be4689c) into main (9d5d236) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #292   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           71        71           
  Lines          582       582           
  Branches       148       148           
=========================================
  Hits           582       582           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9d5d236...be4689c. Read the comment docs.

[SimenB]

https://github.com/jest-community/jest-extended/releases/tag/v3.0.2