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

Adds the TypeScript typings for passing an object to the `preload` setting for `axe.run`, as documented here: https://www.deque.com/axe/core-documentation/api-documentation/#preload-configuration-details > Specifying an object ```js axe.run( { preload: { assets: ['cssom'], timeout: 50000 } }, (err, results) => { // ... } ); ``` Co-authored-by: Andre Wachsmuth <[email protected]>
dequelabs · Oct 16, 2024 · 72e269f · 72e269f
1 parent 9eadbf1
commit 72e269f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/axe.d.ts b/axe.d.ts
@@ -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[];

diff --git a/typings/axe-core/axe-core-tests.ts b/typings/axe-core/axe-core-tests.ts
@@ -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