fix(d.ts): add optional include to ContextObject (#3830)

dequelabs · Dec 14, 2022 · 36ed242 · 36ed242
1 parent bb4ad21
commit 36ed242
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/axe.d.ts b/axe.d.ts
@@ -78,6 +78,7 @@ declare namespace axe {
       }
     | {
         exclude: Selector | SelectorList;
+        include?: Selector | SelectorList;
       };
   type ElementContext = Selector | SelectorList | ContextObject;
 

diff --git a/typings/axe-core/axe-core-tests.ts b/typings/axe-core/axe-core-tests.ts
@@ -66,6 +66,23 @@ export async function runAsync() {
     ]
   });
 }
+
+let ctxt: axe.ContextObject;
+// @ts-expect-error
+ctxt = {};
+ctxt = { exclude: ['foo'] };
+ctxt.include = ['bard'];
+ctxt = { include: ['foo'] };
+ctxt.exclude = ['bar'];
+
+let serialContext: axe.SerialContextObject;
+// @ts-expect-error
+serialContext = {};
+serialContext = { exclude: ['foo'] };
+serialContext.include = ['bard'];
+serialContext = { include: ['foo'] };
+serialContext.exclude = ['bar'];
+
 axe.run(
   { exclude: [$fixture[0]] },
   {},