SnapshotAssertions

Playwright は、ページや要素のスクリーンショットをファイルに保存された期待値と比較するためのメソッドを提供します。

expect(screenshot).toMatchSnapshot('landing-page.png');

メソッド

toMatchSnapshot(name)

追加: v1.22

snapshotAssertions.toMatchSnapshot(name)

注意

スクリーンショットを比較するには、代わりに expect(page).toHaveScreenshot() を使用してください。

渡された値（string または Buffer）が、テストスナップショットディレクトリに保存されている期待されるスナップショットと一致することを確認します。

使用法

// Basic usage.
expect(await page.screenshot()).toMatchSnapshot('landing-page.png');

// Pass options to customize the snapshot comparison and have a generated name.
expect(await page.screenshot()).toMatchSnapshot('landing-page.png', {
  maxDiffPixels: 27, // allow no more than 27 different pixels.
});

// Configure image matching threshold.
expect(await page.screenshot()).toMatchSnapshot('landing-page.png', { threshold: 0.3 });

// Bring some structure to your snapshot files by passing file path segments.
expect(await page.screenshot()).toMatchSnapshot(['landing', 'step2.png']);
expect(await page.screenshot()).toMatchSnapshot(['landing', 'step3.png']);

視覚的比較の詳細をご覧ください。

スナップショットのマッチングは Playwright テストランナーでのみ動作することに注意してください。

引数

name string | Array<string>#

スナップショット名。
options Object (optional)
- maxDiffPixelRatio number (オプション)#
  
  異なるピクセルが総ピクセル数に対して許容される比率で、0 から 1 の間です。デフォルトは TestConfig.expect で設定可能です。デフォルトでは未設定です。
- maxDiffPixels number (オプション)#
  
  異なる可能性がある許容されるピクセル数です。デフォルトは TestConfig.expect で設定可能です。デフォルトでは未設定です。
- threshold number (オプション)#
  
  比較される画像内の同じピクセル間の、YIQ 色空間における許容される知覚的な色差で、ゼロ（厳密）から1（緩やか）の間です。デフォルトは TestConfig.expect で設定可能です。デフォルトは 0.2 です。

toMatchSnapshot(options)

追加: v1.22

snapshotAssertions.toMatchSnapshot(options)

注意

スクリーンショットを比較するには、代わりに expect(page).toHaveScreenshot() を使用してください。

使用法

// Basic usage and the file name is derived from the test name.
expect(await page.screenshot()).toMatchSnapshot();

// Pass options to customize the snapshot comparison and have a generated name.
expect(await page.screenshot()).toMatchSnapshot({
  maxDiffPixels: 27, // allow no more than 27 different pixels.
});

// Configure image matching threshold and snapshot name.
expect(await page.screenshot()).toMatchSnapshot({
  name: 'landing-page.png',
  threshold: 0.3,
});

視覚的比較の詳細をご覧ください。

スナップショットのマッチングは Playwright テストランナーでのみ動作することに注意してください。

引数

options Object (optional)
- maxDiffPixelRatio number (オプション)#
  
  異なるピクセルが総ピクセル数に対して許容される比率で、0 から 1 の間です。デフォルトは TestConfig.expect で設定可能です。デフォルトでは未設定です。
- maxDiffPixels number (オプション)#
  
  異なる可能性がある許容されるピクセル数です。デフォルトは TestConfig.expect で設定可能です。デフォルトでは未設定です。
- name string | Array<string> (オプション)#
  
  スナップショット名。渡されない場合、複数回呼び出される際にはテスト名と順序番号が使用されます。
- threshold number (オプション)#
  
  比較される画像内の同じピクセル間の、YIQ 色空間における許容される知覚的な色差で、ゼロ（厳密）から1（緩やか）の間です。デフォルトは TestConfig.expect で設定可能です。デフォルトは 0.2 です。

メソッド​

toMatchSnapshot(name)​

toMatchSnapshot(options)​

メソッド

toMatchSnapshot(name)

toMatchSnapshot(options)