Skip to content

feat(matchScreenshot): sync from pw-utils #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 26, 2025
Merged

feat(matchScreenshot): sync from pw-utils #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions actions/matchScreenshot.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ export type Theme = 'light' | 'dark';

export type OnSwitchThemeCallback = (theme: Theme, page: Page) => Promise<void>;

export type OnBeforeScreenshotCallback = (page: Page) => Promise<void>;

export type ScreenshotOptions = Omit<PageScreenshotOptions, 'type' | 'quality' | 'path'> & {
/**
* An acceptable ratio of pixels that are different to the total amount of pixels, between `0` and `1`. Default is
Expand All @@ -32,6 +30,8 @@ export type ScreenshotOptions = Omit<PageScreenshotOptions, 'type' | 'quality' |
threshold?: number;
};

export type OnBeforeScreenshotCallback = (page: Page, options: ScreenshotOptions) => Promise<void>;

export type MatchScreenshotOptions = {
/**
* The element or page to be screenshotted
Expand Down Expand Up @@ -158,7 +158,7 @@ export async function matchScreenshot(
await page.mouse.move(x, y);
}

await onBeforeScreenshot?.(page);
await onBeforeScreenshot?.(page, combinedOptions);

const slug = getTestSlug(page);

Expand Down