跳到主要内容

Clock

精确模拟时间相关行为对于验证应用程序的正确性至关重要。了解更多关于时钟模拟的信息。

请注意,时钟是为整个 BrowserContext 安装的,因此所有页面和 iframe 中的时间都由同一个时钟控制。


方法

FastForwardAsync

添加于: v1.45 clock.FastForwardAsync

通过向前跳跃时间来推进时钟。最多只会触发一次到期的定时器。这相当于用户合上笔记本电脑盖一段时间,然后在给定的时间后重新打开。

用法

await page.Clock.FastForwardAsync(1000);
await page.Clock.FastForwardAsync("30:00");

参数

  • ticks long | string#

    时间可以是推进时钟的毫秒数或人类可读的字符串。有效的字符串格式为 "08" 表示八秒,"01:00" 表示一分钟,"02:34:10" 表示两小时 34 分 10 秒。

返回


InstallAsync

添加于: v1.45 clock.InstallAsync

为以下时间相关函数安装伪造的实现

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

伪造定时器用于手动控制测试中的时间流逝。它们允许您推进时间、触发定时器和控制时间相关函数的行为。有关更多信息,请参阅 Clock.RunForAsync()Clock.FastForwardAsync()

用法

await Clock.InstallAsync(options);

参数

  • options ClockInstallOptions? (可选)
    • Time|TimeDate string? | Date? (可选)#

      初始化时间,默认为当前系统时间。

返回


PauseAtAsync

添加于: v1.45 clock.PauseAtAsync

通过向前跳跃时间来推进时钟并暂停时间。一旦调用此方法,除非调用 Clock.RunForAsync()Clock.FastForwardAsync()Clock.PauseAtAsync()Clock.ResumeAsync(),否则不会触发定时器。

最多只会触发一次到期的定时器。这相当于用户合上笔记本电脑盖一段时间,然后在指定时间重新打开并暂停。

用法

await page.Clock.PauseAtAsync(DateTime.Parse("2020-02-02"));
await page.Clock.PauseAtAsync("2020-02-02");

为了获得最佳效果,请在导航页面之前安装时钟,并将其设置为略早于预期测试时间的时间。这确保了所有定时器在页面加载期间正常运行,防止页面卡住。页面完全加载后,您可以安全地使用 Clock.PauseAtAsync() 来暂停时钟。

参数

返回


ResumeAsync

添加于: v1.45 clock.ResumeAsync

恢复定时器。一旦调用此方法,时间将恢复流动,定时器将照常触发。

用法

await Clock.ResumeAsync();

返回


RunForAsync

添加于: v1.45 clock.RunForAsync

推进时钟,触发所有时间相关的回调。

用法

await page.Clock.RunForAsync(1000);
await page.Clock.RunForAsync("30:00");

参数

  • ticks long | string#

    时间可以是推进时钟的毫秒数或人类可读的字符串。有效的字符串格式为 "08" 表示八秒,"01:00" 表示一分钟,"02:34:10" 表示两小时 34 分 10 秒。

返回


SetFixedTimeAsync

添加于: v1.45 clock.SetFixedTimeAsync

使 Date.nownew Date() 始终返回固定的伪造时间,并保持所有定时器运行。

对于只需要使用预定义时间进行测试的简单场景,请使用此方法。对于更高级的场景,请改用 Clock.InstallAsync()。阅读关于时钟模拟的文档以了解更多信息。

用法

await page.Clock.SetFixedTimeAsync(DateTime.Now);
await page.Clock.SetFixedTimeAsync(new DateTime(2020, 2, 2));
await page.Clock.SetFixedTimeAsync("2020-02-02");

参数

返回


SetSystemTimeAsync

添加于: v1.45 clock.SetSystemTimeAsync

设置系统时间,但不触发任何定时器。使用此方法来测试网页如何对时间偏移做出反应,例如从夏季切换到冬季时间,或更改时区。

用法

await page.Clock.SetSystemTimeAsync(DateTime.Now);
await page.Clock.SetSystemTimeAsync(new DateTime(2020, 2, 2));
await page.Clock.SetSystemTimeAsync("2020-02-02");

参数

返回