Skip to main content

Clock

Accurately simulating time-dependent behavior is essential for verifying the correctness of applications. Learn more about clock emulation.

Note that clock is installed for the entire BrowserContext, so the time in all the pages and iframes is controlled by the same clock.

Methods​

fastForward​

Added in: v1.45 clock.fastForward

Advance the clock by jumping forward in time. Only fires due timers at most once. This is equivalent to user closing the laptop lid for a while and reopening it later, after given time.

Usage

await page.clock.fastForward(1000);
await page.clock.fastForward('30:00');

Arguments

  • ticks number | string#

    Time may be the number of milliseconds to advance the clock by or a human-readable string. Valid string formats are "08" for eight seconds, "01:00" for one minute and "02:34:10" for two hours, 34 minutes and ten seconds.

Returns

install​

Added in: v1.45 clock.install

Install fake implementations for the following time-related functions:

  • Date
  • setTimeout
  • clearTimeout
  • setInterval
  • clearInterval
  • requestAnimationFrame
  • cancelAnimationFrame
  • requestIdleCallback
  • cancelIdleCallback
  • performance

Fake timers are used to manually control the flow of time in tests. They allow you to advance time, fire timers, and control the behavior of time-dependent functions. See clock.runFor() and clock.fastForward() for more information.

Usage

await clock.install();
await clock.install(options);

Arguments

  • options Object (optional)

    • time number | string | [Date] (optional)#

      Time to initialize with, current system time by default.

Returns

pauseAt​

Added in: v1.45 clock.pauseAt

Advance the clock by jumping forward in time and pause the time. Once this method is called, no timers are fired unless clock.runFor(), clock.fastForward(), clock.pauseAt() or clock.resume() is called.

Only fires due timers at most once. This is equivalent to user closing the laptop lid for a while and reopening it at the specified time and pausing.

Usage

await page.clock.pauseAt(new Date('2020-02-02'));
await page.clock.pauseAt('2020-02-02');

Arguments

Returns

resume​

Added in: v1.45 clock.resume

Resumes timers. Once this method is called, time resumes flowing, timers are fired as usual.

Usage

await clock.resume();

Returns

runFor​

Added in: v1.45 clock.runFor

Advance the clock, firing all the time-related callbacks.

Usage

await page.clock.runFor(1000);
await page.clock.runFor('30:00');

Arguments

  • ticks number | string#

    Time may be the number of milliseconds to advance the clock by or a human-readable string. Valid string formats are "08" for eight seconds, "01:00" for one minute and "02:34:10" for two hours, 34 minutes and ten seconds.

Returns

setFixedTime​

Added in: v1.45 clock.setFixedTime

Makes Date.now and new Date() return fixed fake time at all times, keeps all the timers running.

Use this method for simple scenarios where you only need to test with a predefined time. For more advanced scenarios, use clock.install() instead. Read docs on clock emulation to learn more.

Usage

await page.clock.setFixedTime(Date.now());
await page.clock.setFixedTime(new Date('2020-02-02'));
await page.clock.setFixedTime('2020-02-02');

Arguments

Returns

setSystemTime​

Added in: v1.45 clock.setSystemTime

Sets system time, but does not trigger any timers. Use this to test how the web page reacts to a time shift, for example switching from summer to winter time, or changing time zones.

Usage

await page.clock.setSystemTime(Date.now());
await page.clock.setSystemTime(new Date('2020-02-02'));
await page.clock.setSystemTime('2020-02-02');

Arguments

Returns