Skip to content

Commit 8ef8c20

Browse files
authored
docs: add documentation of the jest.deepUnmock() method (#13774)
1 parent c010e35 commit 8ef8c20

File tree

9 files changed

+54
-0
lines changed

9 files changed

+54
-0
lines changed

docs/JestObjectAPI.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,6 +364,12 @@ The most common use of this API is for specifying the module a given test intend
364364

365365
Returns the `jest` object for chaining.
366366

367+
### `jest.deepUnmock(moduleName)`
368+
369+
Indicates that the module system should never return a mocked version of the specified module and its dependencies.
370+
371+
Returns the `jest` object for chaining.
372+
367373
### `jest.doMock(moduleName, factory, options)`
368374

369375
When using `babel-jest`, calls to `mock` will automatically be hoisted to the top of the code block. Use this method if you want to explicitly avoid this behavior.

website/versioned_docs/version-25.x/JestObjectAPI.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,12 @@ The most common use of this API is for specifying the module a given test intend
286286

287287
Returns the `jest` object for chaining.
288288

289+
### `jest.deepUnmock(moduleName)`
290+
291+
Indicates that the module system should never return a mocked version of the specified module and its dependencies.
292+
293+
Returns the `jest` object for chaining.
294+
289295
### `jest.doMock(moduleName, factory, options)`
290296

291297
When using `babel-jest`, calls to `mock` will automatically be hoisted to the top of the code block. Use this method if you want to explicitly avoid this behavior.

website/versioned_docs/version-26.x/JestObjectAPI.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,12 @@ The most common use of this API is for specifying the module a given test intend
290290

291291
Returns the `jest` object for chaining.
292292

293+
### `jest.deepUnmock(moduleName)`
294+
295+
Indicates that the module system should never return a mocked version of the specified module and its dependencies.
296+
297+
Returns the `jest` object for chaining.
298+
293299
### `jest.doMock(moduleName, factory, options)`
294300

295301
When using `babel-jest`, calls to `mock` will automatically be hoisted to the top of the code block. Use this method if you want to explicitly avoid this behavior.

website/versioned_docs/version-27.x/JestObjectAPI.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,12 @@ The most common use of this API is for specifying the module a given test intend
290290

291291
Returns the `jest` object for chaining.
292292

293+
### `jest.deepUnmock(moduleName)`
294+
295+
Indicates that the module system should never return a mocked version of the specified module and its dependencies.
296+
297+
Returns the `jest` object for chaining.
298+
293299
### `jest.doMock(moduleName, factory, options)`
294300

295301
When using `babel-jest`, calls to `mock` will automatically be hoisted to the top of the code block. Use this method if you want to explicitly avoid this behavior.

website/versioned_docs/version-28.x/JestObjectAPI.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,12 @@ The most common use of this API is for specifying the module a given test intend
290290

291291
Returns the `jest` object for chaining.
292292

293+
### `jest.deepUnmock(moduleName)`
294+
295+
Indicates that the module system should never return a mocked version of the specified module and its dependencies.
296+
297+
Returns the `jest` object for chaining.
298+
293299
### `jest.doMock(moduleName, factory, options)`
294300

295301
When using `babel-jest`, calls to `mock` will automatically be hoisted to the top of the code block. Use this method if you want to explicitly avoid this behavior.

website/versioned_docs/version-29.0/JestObjectAPI.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,12 @@ The most common use of this API is for specifying the module a given test intend
332332

333333
Returns the `jest` object for chaining.
334334

335+
### `jest.deepUnmock(moduleName)`
336+
337+
Indicates that the module system should never return a mocked version of the specified module and its dependencies.
338+
339+
Returns the `jest` object for chaining.
340+
335341
### `jest.doMock(moduleName, factory, options)`
336342

337343
When using `babel-jest`, calls to `mock` will automatically be hoisted to the top of the code block. Use this method if you want to explicitly avoid this behavior.

website/versioned_docs/version-29.1/JestObjectAPI.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,6 +364,12 @@ The most common use of this API is for specifying the module a given test intend
364364

365365
Returns the `jest` object for chaining.
366366

367+
### `jest.deepUnmock(moduleName)`
368+
369+
Indicates that the module system should never return a mocked version of the specified module and its dependencies.
370+
371+
Returns the `jest` object for chaining.
372+
367373
### `jest.doMock(moduleName, factory, options)`
368374

369375
When using `babel-jest`, calls to `mock` will automatically be hoisted to the top of the code block. Use this method if you want to explicitly avoid this behavior.

website/versioned_docs/version-29.2/JestObjectAPI.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,6 +364,12 @@ The most common use of this API is for specifying the module a given test intend
364364

365365
Returns the `jest` object for chaining.
366366

367+
### `jest.deepUnmock(moduleName)`
368+
369+
Indicates that the module system should never return a mocked version of the specified module and its dependencies.
370+
371+
Returns the `jest` object for chaining.
372+
367373
### `jest.doMock(moduleName, factory, options)`
368374

369375
When using `babel-jest`, calls to `mock` will automatically be hoisted to the top of the code block. Use this method if you want to explicitly avoid this behavior.

website/versioned_docs/version-29.3/JestObjectAPI.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,6 +364,12 @@ The most common use of this API is for specifying the module a given test intend
364364

365365
Returns the `jest` object for chaining.
366366

367+
### `jest.deepUnmock(moduleName)`
368+
369+
Indicates that the module system should never return a mocked version of the specified module and its dependencies.
370+
371+
Returns the `jest` object for chaining.
372+
367373
### `jest.doMock(moduleName, factory, options)`
368374

369375
When using `babel-jest`, calls to `mock` will automatically be hoisted to the top of the code block. Use this method if you want to explicitly avoid this behavior.

0 commit comments

Comments
 (0)