Report this

What is the reason for this report?

Jest Mock Timers

Published on June 8, 2017
Matthew Garcia

By Matthew Garcia

Jest Mock Timers

One of the biggest hurdles to testing timeouts is waiting for them to time out. Jest provides a way around this.

runAllTimers

Let’s say you’re testing a program that emits an event after some time, but you don’t want to wait however long for that event to actually be emitted. Jest gives you the option of instantly running callbacks set with setTimeout through the jest.runAllTimers function.

// This has to be called before using fake timers.
jest.useFakeTimers();

it('closes some time after being opened.', (done) => {
  // An automatic door that fires a `closed` event.
  const autoDoor = new AutoDoor();
  autoDoor.on('closed', done);
  autoDoor.open();
  // Runs all pending timers. whether it's a second from now or a year.
  jest.runAllTimers();
});

runTimersToTime

But what if you don’t want to run all timers? What if you only want to simulate some time passing? runTimersToTime is here for you.

jest.useFakeTimers();

it('announces it will close before closing.', (done) => {
  const autoDoor = new AutoDoor();
  // The test passes if there's a `closing` event.
  autoDoor.on('closing', done);
  // The test fails if there's a `closed` event.
  autoDoor.on('closed', done.fail);
  autoDoor.open();
  // Only move ahead enough time so that it starts closing, but not enough that it is closed.
  jest.runTimersToTime(autoDoor.TIME_BEFORE_CLOSING);
});

Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.

Learn more about our products

About the author

Matthew Garcia
Matthew Garcia
Author
Category:
Tags:
While we believe that this content benefits our community, we have not yet thoroughly reviewed it. If you have any suggestions for improvements, please let us know by clicking the “report an issue“ button at the bottom of the tutorial.

Still looking for an answer?

Was this helpful?


This textbox defaults to using Markdown to format your answer.

You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!

Creative CommonsThis work is licensed under a Creative Commons Attribution-NonCommercial- ShareAlike 4.0 International License.
Join the Tech Talk
Success! Thank you! Please check your email for further details.

Please complete your information!

The developer cloud

Scale up as you grow — whether you're running one virtual machine or ten thousand.

Get started for free

Sign up and get $200 in credit for your first 60 days with DigitalOcean.*

*This promotional offer applies to new accounts only.