メインコンテンツにスキップ

時計

時間依存の動作を正確にシミュレートすることは、アプリケーションの正しさを検証するために不可欠です。クロックエミュレーションについて詳しくはこちらをご覧ください。

クロックはBrowserContext全体にインストールされるため、すべてのページとiframeの時間は同じクロックによって制御されることに注意してください。


メソッド

fastForward

追加されたバージョン: v1.45 clock.fastForward

時間を早送りしてクロックを進めます。期限切れのタイマーは最大1回だけ発火します。これは、ユーザーがしばらくノートパソコンの蓋を閉めて、指定された時間後に再び開くのと同等です。

使用法

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

引数

  • ticks number | string#

    時間は、クロックを進めるミリ秒数、または人間が判読できる文字列のいずれかです。有効な文字列形式は、8秒の場合は「08」、1分の場合は「01:00」、2時間34分10秒の場合は「02:34:10」です。

戻り値


install

追加されたバージョン: v1.45 clock.install

以下の時間関連関数の偽の実装をインストールします

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

フェイクタイマーは、テストで時間の流れを手動で制御するために使用されます。これにより、時間を進めたり、タイマーを起動したり、時間依存関数の動作を制御したりできます。詳細については、clock.runFor()clock.fastForward() を参照してください。

使用法

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

引数

  • options Object (optional)
    • time number | string | Date (オプション)#

      初期化する時間。デフォルトは現在のシステム時間です。

戻り値


pauseAt

追加されたバージョン: v1.45 clock.pauseAt

時間を進めて、時間を一時停止します。このメソッドが呼び出されると、clock.runFor()clock.fastForward()clock.pauseAt()、または clock.resume() が呼び出されない限り、タイマーは起動しません。

期限切れのタイマーは最大1回だけ発火します。これは、ユーザーがしばらくノートパソコンの蓋を閉めて、指定された時間に再び開いて一時停止するのと同等です。

使用法

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

最良の結果を得るには、ページをナビゲートする前にクロックをインストールし、テストの意図された時刻より少し前の時刻に設定してください。これにより、ページの読み込み中にすべてのタイマーが正常に動作し、ページが停止するのを防ぐことができます。ページが完全に読み込まれたら、安全に clock.pauseAt() を使用してクロックを一時停止できます。

// Initialize clock with some time before the test time and let the page load
// naturally. `Date.now` will progress as the timers fire.
await page.clock.install({ time: new Date('2024-12-10T08:00:00') });
await page.goto('https://:3333');
await page.clock.pauseAt(new Date('2024-12-10T10:00:00'));

引数

戻り値


resume

追加されたバージョン: v1.45 clock.resume

タイマーを再開します。このメソッドが呼び出されると、時間の流れが再開され、タイマーは通常通り発火します。

使用法

await clock.resume();

戻り値


runFor

追加されたバージョン: v1.45 clock.runFor

クロックを進め、時間関連のすべてのコールバックを発火させます。

使用法

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

引数

  • ticks number | string#

    時間は、クロックを進めるミリ秒数、または人間が判読できる文字列のいずれかです。有効な文字列形式は、8秒の場合は「08」、1分の場合は「01:00」、2時間34分10秒の場合は「02:34:10」です。

戻り値


setFixedTime

追加されたバージョン: v1.45 clock.setFixedTime

Date.nownew Date()が常に固定された偽の時間を返し、すべてのタイマーを実行し続けます。

このメソッドは、事前定義された時間でテストするだけでよい単純なシナリオで使用します。より高度なシナリオでは、代わりに clock.install() を使用してください。クロックエミュレーションに関するドキュメントを読んで、詳細を確認してください。

使用法

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

引数

戻り値


setSystemTime

追加されたバージョン: v1.45 clock.setSystemTime

システム時間を設定しますが、タイマーはトリガーしません。これを使用して、夏時間から冬時間への切り替えやタイムゾーンの変更など、ウェブページが時間の変更にどのように反応するかをテストします。

使用法

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

引数

戻り値