vitest-plugin-vis/src/client/actions/match_page_image_snapshot_action.ts

Vitest visual testing plugin

import type { BrowserCommands } from 'vitest/browser'
import { assertSnapshotKeyWithoutDash } from '../../shared/asserts.ts'
import type {
	ImageSnapshotNextIndexCommand,
	PrepareImageSnapshotComparisonCommand,
} from '../../shared/commands.types.ts'
import type { ToMatchImageSnapshotOptions } from '../../shared/types.ts'
import { compareImageSnapshot } from '../snapshot/compare_image_snapshot.ts'

export async function matchPageImageSnapshotAction(
	commands: BrowserCommands & PrepareImageSnapshotComparisonCommand & ImageSnapshotNextIndexCommand,
	taskId: string,
	options?: ToMatchImageSnapshotOptions<any>,
) {
	assertSnapshotKeyWithoutDash(options?.snapshotKey)

	const info = await commands.preparePageImageSnapshotComparison(taskId, options)

	if (!info) return

	return compareImageSnapshot(commands, taskId, info, options)
}