Add TypeScript typings for preload options object

dequelabs · Jul 23, 2024 · c867c5b · c867c5b
1 parent 07c5d91
commit c867c5b
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