// Tutorial //

Jest Mock Timers

Published on June 8, 2017
    Default avatar

    By Matthew Garcia

    Jest Mock Timers

    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.

    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 us


    About the authors
    Default avatar
    Matthew Garcia

    author

    Still looking for an answer?

    Ask a questionSearch for more help

    Was this helpful?
     
    Leave a comment
    

    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!

    Try DigitalOcean for free

    Click below to sign up and get $200 of credit to try our products over 60 days!

    Sign up

    card icon
    Get our biweekly newsletter

    Sign up for Infrastructure as a Newsletter.

    Sign up
    card icon
    Hollie's Hub for Good

    Working on improving health and education, reducing inequality, and spurring economic growth? We’d like to help.

    Learn more
    card icon
    Become a contributor

    You get paid; we donate to tech nonprofits.

    Learn more
    Welcome to the developer cloud

    DigitalOcean makes it simple to launch in the cloud and scale up as you grow – whether you’re running one virtual machine or ten thousand.

    Learn more ->
    DigitalOcean Cloud Control Panel
    Get started for free

    Enter your email to get $200 in credit for your first 60 days with DigitalOcean.

    New accounts only. By submitting your email you agree to our Privacy Policy.

    © 2023 DigitalOcean, LLC.