Skip to content

fix(axe.d.ts): add typings for preload options object #4543

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
Jul 30, 2024
Merged

fix(axe.d.ts): add typings for preload options object #4543

Show file tree
Hide file tree
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: 5 additions & 1 deletion axe.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,10 +143,14 @@ declare namespace axe {
iframes?: boolean;
elementRef?: boolean;
frameWaitTime?: number;
preload?: boolean;
preload?: boolean | PreloadOptions;
performanceTimer?: boolean;
pingWaitTime?: number;
}
interface PreloadOptions {
assets: string[];
timeout?: number;
}
interface AxeResults extends EnvironmentData {
toolOptions: RunOptions;
passes: Result[];
Expand Down
7 changes: 7 additions & 0 deletions typings/axe-core/axe-core-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,13 @@ axe.run(
console.log(error || results);
}
);
// axe.run preload: boolean
axe.run({ preload: false });
axe.run({ preload: true });
// axe.run preload: options
axe.run({ preload: { assets: ['cssom'] } });
axe.run({ preload: { assets: ['cssom'], timeout: 50000 } });

export async function runAsync() {
await axe.run('main'); // Single selector
await axe.run(['main']); // Array of one selector
Expand Down