From 4fd40cc6c4f8424af24103a59ed83b5c959d6564 Mon Sep 17 00:00:00 2001
From: Luiz Kota <luiz.zk@gmail.com>
Date: Thu, 9 Feb 2017 11:33:22 -0200
Subject: [PATCH] Updating the TimerMocks Documentation (#2841)

* Add runTimersToTime in TimerMocks documentation

* Adjusting jest.runTimersToTime in documentation

* Update TimerMocks.md
---
 docs/TimerMocks.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/docs/TimerMocks.md b/docs/TimerMocks.md
index f0b660d1fabf..976b7e439e2d 100644
--- a/docs/TimerMocks.md
+++ b/docs/TimerMocks.md
@@ -131,6 +131,45 @@ describe('infiniteTimerGame', () => {
   });
 });
 ```
+
+## Run Timers to Time
+
+Another possibility is use `jest.runTimersToTime(msToRun)`. When this API is called, all pending "macro-tasks" that have been queued via setTimeout() or setInterval(), and would be executed within msToRun milliseconds, 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.
+
+```javascript
+// timerGame.js
+'use strict';
+
+function timerGame(callback) {
+  console.log('Ready....go!');
+  setTimeout(() => {
+    console.log('Times up -- stop!');
+    callback && callback();
+  }, 1000);
+}
+
+module.exports = timerGame;
+```
+
+```javascript
+it('calls the callback after 1 second via runTimersToTime', () => {
+    const timerGame = require('../timerGame');
+    const callback = jest.fn();
+
+    timerGame(callback);
+
+    // At this point in time, the callback should not have been called yet
+    expect(callback).not.toBeCalled();
+
+    // Fast-forward until all timers have been executed
+    jest.runTimersToTime(1000);
+
+    // Now our callback should have been called!
+    expect(callback).toBeCalled();
+    expect(callback.mock.calls.length).toBe(1);
+  });
+```
+
 Lastly, it may occasionally be useful in some tests to be able to clear all of
 the pending timers. For this, we have `jest.clearAllTimers()`.