Skip to content

fix: use named export for 'percyScreenshot' #589

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

Open
Katona wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix: use named export for 'percyScreenshot' #589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0209919
fix: use named export for 'percyScreenshot'
Feb 24, 2026
3b86037
refactor: undo accidental formatting
Feb 24, 2026
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
8 changes: 7 additions & 1 deletion types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@ export default function percySnapshot(
options?: SnapshotOptions
): Promise<void>;

export default function percyScreenshot(
export function percyScreenshot(
page: Playwright.Page,
name: string,
options?: SnapshotOptions
): Promise<void>;

export function percySnapshot(
page: Playwright.Page,
name: string,
options?: SnapshotOptions
Expand Down
10 changes: 9 additions & 1 deletion types/index.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
import { expectType, expectError } from 'tsd';
import * as Playwright from 'playwright';
import percySnapshot from '.';
import percyScreenshot from '.';
import { percyScreenshot } from '.';

declare const page: Playwright.Page;

//@ts-expect-error
expectError(percySnapshot());
//@ts-expect-error
expectError(percySnapshot(page));
//@ts-expect-error
expectError(percySnapshot('Snapshot name'));
//@ts-expect-error
expectError(percyScreenshot());
//@ts-expect-error
expectError(percyScreenshot(page));
//@ts-expect-error
expectError(percyScreenshot('Snapshot name'));

expectType<Promise<void>>(percySnapshot(page, 'Snapshot name'));
Expand All @@ -18,5 +24,7 @@ expectType<Promise<void>>(percySnapshot(page, 'Snapshot name', { widths: [1000]
expectType<Promise<void>>(percyScreenshot(page, 'Snapshot name'));
expectType<Promise<void>>(percyScreenshot(page, 'Snapshot name', { widths: [1000] }));

//@ts-expect-error
expectError(percySnapshot(page, 'Snapshot name', { foo: 'bar' }));
//@ts-expect-error
expectError(percyScreenshot(page, 'Snapshot name', { foo: 'bar' }));