fix(d.ts): RunOptions.reporter can be any string (#4218)

Co-authored-by: Steven Lambert <2433219+straker@users.noreply.github.com>
dequelabs · Nov 2, 2023 · e53f5c5 · e53f5c5
1 parent d660518
commit e53f5c5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/axe.d.ts b/axe.d.ts
@@ -6,7 +6,7 @@ declare namespace axe {
 
   type TagValue = string;
 
-  type ReporterVersion = 'v1' | 'v2' | 'raw' | 'raw-env' | 'no-passes';
+  type ReporterVersion = 'v1' | 'v2' | 'raw' | 'rawEnv' | 'no-passes';
 
   type RunOnlyType = 'rule' | 'rules' | 'tag' | 'tags';
 
@@ -131,7 +131,7 @@ declare namespace axe {
   interface RunOptions {
     runOnly?: RunOnly | TagValue[] | string[] | string;
     rules?: RuleObject;
-    reporter?: ReporterVersion;
+    reporter?: ReporterVersion | string;
     resultTypes?: resultGroups[];
     selectors?: boolean;
     ancestry?: boolean;

diff --git a/typings/axe-core/axe-core-tests.ts b/typings/axe-core/axe-core-tests.ts
@@ -2,7 +2,13 @@ import * as axe from '../../axe';
 
 var context: any = document;
 var $fixture = [document];
-var options = { iframes: false, selectors: false, elementRef: false };
+var options: axe.RunOptions = {
+  iframes: false,
+  selectors: false,
+  elementRef: false
+};
+options.reporter = 'rawEnv';
+options.reporter = 'custom';
 
 axe.run(context, {}, (error: Error, results: axe.AxeResults) => {
   if (error) {