The Jest Object
The jest object is automatically in scope within every test file. The methods in the jest object help create mocks and let you control Jest's overall behavior. It can also be imported explicitly by via import {jest} from '@jest/globals'.
Mock Modules#
jest.disableAutomock()#
Disables automatic mocking in the module loader.
See
automocksection of configuration for more information
After this method is called, all require()s will return the real versions of each module (rather than a mocked version).
Jest configuration:
Example:
This is usually useful when you have a scenario where the number of dependencies you want to mock is far less than the number of dependencies that you don't. For example, if you're writing a test for a module that uses a large number of dependencies that can be reasonably classified as "implementation details" of the module, then you likely do not want to mock them.
Examples of dependencies that might be considered "implementation details" are things ranging from language built-ins (e.g. Array.prototype methods) to highly common utility methods (e.g. underscore/lo-dash, array utilities, etc) and entire libraries like React.js.
Returns the jest object for chaining.
Note: this method was previously called autoMockOff. When using babel-jest, calls to disableAutomock will automatically be hoisted to the top of the code block. Use autoMockOff if you want to explicitly avoid this behavior.
jest.enableAutomock()#
Enables automatic mocking in the module loader.
Returns the jest object for chaining.
See
automocksection of configuration for more information
Example:
Note: this method was previously called autoMockOn. When using babel-jest, calls to enableAutomock will automatically be hoisted to the top of the code block. Use autoMockOn if you want to explicitly avoid this behavior.
jest.createMockFromModule(moduleName)#
renamed in Jest 26.0.0+#
Also under the alias: .genMockFromModule(moduleName)
Given the name of a module, use the automatic mocking system to generate a mocked version of the module for you.
This is useful when you want to create a manual mock that extends the automatic mock's behavior.
Example:
This is how createMockFromModule will mock the following data types:
Function#
Creates a new mock function. The new function has no formal parameters and when called will return undefined. This functionality also applies to async functions.
Class#
Creates a new class. The interface of the original class is maintained, all of the class member functions and properties will be mocked.
Object#
Creates a new deeply cloned object. The object keys are maintained and their values are mocked.
Array#
Creates a new empty array, ignoring the original.
Primitives#
Creates a new property with the same primitive value as the original property.
Example:
jest.mock(moduleName, factory, options)#
Mocks a module with an auto-mocked version when it is being required. factory and options are optional. For example:
The second argument can be used to specify an explicit module factory that is being run instead of using Jest's automocking feature:
When using the factory parameter for an ES6 module with a default export, the __esModule: true property needs to be specified. This property is normally generated by Babel / TypeScript, but here it needs to be set manually. When importing a default export, it's an instruction to import the property named default from the export object:
The third argument can be used to create virtual mocks – mocks of modules that don't exist anywhere in the system:
Warning: Importing a module in a setup file (as specified by
setupTestFrameworkScriptFile) will prevent mocking for the module in question, as well as all the modules that it imports.
Modules that are mocked with jest.mock are mocked only for the file that calls jest.mock. Another file that imports the module will get the original implementation even if it runs after the test file that mocks the module.
Returns the jest object for chaining.
jest.unmock(moduleName)#
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).
The most common use of this API is for specifying the module a given test intends to be testing (and thus doesn't want automatically mocked).
Returns the jest object for chaining.
jest.doMock(moduleName, factory, options)#
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.
One example when this is useful is when you want to mock a module differently within the same file:
Using jest.doMock() with ES6 imports requires additional steps. Follow these if you don't want to use require in your tests:
- We have to specify the
__esModule: trueproperty (see thejest.mock()API for more information). - Static ES6 module imports are hoisted to the top of the file, so instead we have to import them dynamically using
import(). - Finally, we need an environment which supports dynamic importing. Please see Using Babel for the initial setup. Then add the plugin babel-plugin-dynamic-import-node, or an equivalent, to your Babel config to enable dynamic importing in Node.
Returns the jest object for chaining.
jest.dontMock(moduleName)#
When using babel-jest, calls to unmock will automatically be hoisted to the top of the code block. Use this method if you want to explicitly avoid this behavior.
Returns the jest object for chaining.
jest.setMock(moduleName, moduleExports)#
Explicitly supplies the mock object that the module system should return for the specified module.
On occasion, there are times where the automatically generated mock the module system would normally provide you isn't adequate enough for your testing needs. Normally under those circumstances you should write a manual mock that is more adequate for the module in question. However, on extremely rare occasions, even a manual mock isn't suitable for your purposes and you need to build the mock yourself inside your test.
In these rare scenarios you can use this API to manually fill the slot in the module system's mock-module registry.
Returns the jest object for chaining.
Note It is recommended to use jest.mock() instead. The jest.mock API's second argument is a module factory instead of the expected exported module object.
jest.requireActual(moduleName)#
Returns the actual module instead of a mock, bypassing all checks on whether the module should receive a mock implementation or not.
Example:
jest.requireMock(moduleName)#
Returns a mock module instead of the actual module, bypassing all checks on whether the module should be required normally or not.
jest.resetModules()#
Resets the module registry - the cache of all required modules. This is useful to isolate modules where local state might conflict between tests.
Example:
Example in a test:
Returns the jest object for chaining.
jest.isolateModules(fn)#
jest.isolateModules(fn) goes a step further than jest.resetModules() and creates a sandbox registry for the modules that are loaded inside the callback function. This is useful to isolate specific modules for every test so that local module state doesn't conflict between tests.
Mock functions#
jest.fn(implementation)#
Returns a new, unused mock function. Optionally takes a mock implementation.
jest.isMockFunction(fn)#
Determines if the given function is a mocked function.
jest.spyOn(object, methodName)#
Creates a mock function similar to jest.fn but also tracks calls to object[methodName]. Returns a Jest mock function.
Note: By default, jest.spyOn also calls the spied method. This is different behavior from most other test libraries. If you want to overwrite the original function, you can use jest.spyOn(object, methodName).mockImplementation(() => customImplementation) or object[methodName] = jest.fn(() => customImplementation);
Example:
Example test:
jest.spyOn(object, methodName, accessType?)#
Since Jest 22.1.0+, the jest.spyOn method takes an optional third argument of accessType that can be either 'get' or 'set', which proves to be useful when you want to spy on a getter or a setter, respectively.
Example:
Example test:
jest.clearAllMocks()#
Clears the mock.calls and mock.instances properties of all mocks. Equivalent to calling .mockClear() on every mocked function.
Returns the jest object for chaining.
jest.resetAllMocks()#
Resets the state of all mocks. Equivalent to calling .mockReset() on every mocked function.
Returns the jest object for chaining.
jest.restoreAllMocks()#
Restores all mocks back to their original value. Equivalent to calling .mockRestore() on every mocked function. Beware that jest.restoreAllMocks() only works when the mock was created with jest.spyOn; other mocks will require you to manually restore them.
Mock timers#
jest.useFakeTimers(implementation?: 'modern' | 'legacy')#
Instructs Jest to use fake versions of the standard timer functions (setTimeout, setInterval, clearTimeout, clearInterval, nextTick, setImmediate and clearImmediate as well as Date).
If you pass 'legacy' as an argument, Jest's legacy implementation will be used rather than one based on @sinonjs/fake-timers.
Returns the jest object for chaining.
jest.useRealTimers()#
Instructs Jest to use the real versions of the standard timer functions.
Returns the jest object for chaining.
jest.runAllTicks()#
Exhausts the micro-task queue (usually interfaced in node via process.nextTick).
When this API is called, all pending micro-tasks that have been queued via process.nextTick will be executed. Additionally, if those micro-tasks themselves schedule new micro-tasks, those will be continually exhausted until there are no more micro-tasks remaining in the queue.
jest.runAllTimers()#
Exhausts both the macro-task queue (i.e., all tasks queued by setTimeout(), setInterval(), and setImmediate()) and the micro-task queue (usually interfaced in node via process.nextTick).
When this API is called, all pending macro-tasks and micro-tasks will be executed. If those tasks themselves schedule new tasks, those will be continually exhausted until there are no more tasks remaining in the queue.
This is often useful for synchronously executing setTimeouts during a test in order to synchronously assert about some behavior that would only happen after the setTimeout() or setInterval() callbacks executed. See the Timer mocks doc for more information.
jest.runAllImmediates()#
Exhausts all tasks queued by setImmediate().
Note: This function is not available when using modern fake timers implementation
jest.advanceTimersByTime(msToRun)#
Executes only the macro task queue (i.e. all tasks queued by setTimeout() or setInterval() and setImmediate()).
When this API is called, all timers are advanced by msToRun milliseconds. All pending "macro-tasks" that have been queued via setTimeout() or setInterval(), and would be executed within this time frame will be executed. Additionally, if those macro-tasks schedule new macro-tasks that would be executed within the same time frame, those will be executed until there are no more macro-tasks remaining in the queue, that should be run within msToRun milliseconds.
jest.runOnlyPendingTimers()#
Executes only the macro-tasks that are currently pending (i.e., only the tasks that have been queued by setTimeout() or setInterval() up to this point). If any of the currently pending macro-tasks schedule new macro-tasks, those new tasks will not be executed by this call.
This is useful for scenarios such as one where the module being tested schedules a setTimeout() whose callback schedules another setTimeout() recursively (meaning the scheduling never stops). In these scenarios, it's useful to be able to run forward in time by a single step at a time.
jest.advanceTimersToNextTimer(steps)#
Advances all timers by the needed milliseconds so that only the next timeouts/intervals will run.
Optionally, you can provide steps, so it will run steps amount of next timeouts/intervals.
jest.clearAllTimers()#
Removes any pending timers from the timer system.
This means, if any timers have been scheduled (but have not yet executed), they will be cleared and will never have the opportunity to execute in the future.
jest.getTimerCount()#
Returns the number of fake timers still left to run.
jest.setSystemTime(now?: number | Date)#
Set the current system time used by fake timers. Simulates a user changing the system clock while your program is running. It affects the current time but it does not in itself cause e.g. timers to fire; they will fire exactly as they would have done without the call to jest.setSystemTime().
Note: This function is only available when using modern fake timers implementation
jest.getRealSystemTime()#
When mocking time, Date.now() will also be mocked. If you for some reason need access to the real current time, you can invoke this function.
Note: This function is only available when using modern fake timers implementation
Misc#
jest.setTimeout(timeout)#
Set the default timeout interval for tests and before/after hooks in milliseconds. This only affects the test file from which this function is called.
Note: The default timeout interval is 5 seconds if this method is not called.
Note: If you want to set the timeout for all test files, a good place to do this is in setupFilesAfterEnv.
Example:
jest.retryTimes()#
Runs failed tests n-times until they pass or until the max number of retries is exhausted. This only works with the default jest-circus runner!
Example in a test:
Returns the jest object for chaining.