🤖 Merge PR DefinitelyTyped#60278 [jest] Make jest.mock type-safe by @…

…mathieulag
lgarron · May 11, 2022 · fe81c93 · fe81c93
1 parent c5a1947
commit fe81c93
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/types/jest/index.d.ts b/types/jest/index.d.ts
@@ -146,7 +146,8 @@ declare namespace jest {
     /**
      * Mocks a module with an auto-mocked version when it is being required.
      */
-    function doMock(moduleName: string, factory?: () => unknown, options?: MockOptions): typeof jest;
+    // tslint:disable-next-line no-unnecessary-generics
+    function doMock<T = unknown>(moduleName: string, factory?: () => T, options?: MockOptions): typeof jest;
     /**
      * Indicates that the module system should never return a mocked version
      * of the specified module from require() (e.g. that it should always return the real module).
@@ -177,7 +178,8 @@ declare namespace jest {
     /**
      * Mocks a module with an auto-mocked version when it is being required.
      */
-    function mock(moduleName: string, factory?: () => unknown, options?: MockOptions): typeof jest;
+    // tslint:disable-next-line no-unnecessary-generics
+    function mock<T = unknown>(moduleName: string, factory?: () => T, options?: MockOptions): typeof jest;
 
     /**
      * The mocked test helper provides typings on your mocked modules and even

diff --git a/types/jest/jest-tests.ts b/types/jest/jest-tests.ts
@@ -275,12 +275,18 @@ jest.autoMockOff()
     .doMock('moduleName', jest.fn())
     .doMock('moduleName', jest.fn(), {})
     .doMock('moduleName', jest.fn(), { virtual: true })
+    .doMock<{animal: string}>('moduleName', () => ({animal: 'cat'}))
+    // $ExpectError
+    .doMock<{animal: string}>('moduleName', () => ({name: 'tom'}))
     .dontMock('moduleName')
     .enableAutomock()
     .mock('moduleName')
     .mock('moduleName', jest.fn())
     .mock('moduleName', jest.fn(), {})
     .mock('moduleName', jest.fn(), { virtual: true })
+    .mock<{animal: string}>('moduleName', () => ({animal: 'cat'}))
+    // $ExpectError
+    .mock<{animal: string}>('moduleName', () => ({name: 'tom'}))
     .resetModules()
     .isolateModules(() => {})
     .retryTimes(3)