Skip to content

Commit

Permalink
docs: add all reporters to axe.configure parameters (#1626)
Browse files Browse the repository at this point in the history
  • Loading branch information
straker authored Jun 10, 2019
1 parent 4e12217 commit 96a1ea8
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,9 @@ axe.configure({
- `reporter` - Used to set the output format that the axe.run function will pass to the callback function
- `v1` to use the previous version's format: `axe.configure({ reporter: "v1" });`
- `v2` to use the current version's format: `axe.configure({ reporter: "v2" });`
- `raw` to return the raw result data without formating: `axe.configure({ reporter: "raw" });`
- `raw-env` to return the raw result data with environment data: `axe.configure({ reporter: "raw-env" });`
- `no-passes` to return only violation results: `axe.configure({ reporter: "no-passes" });`
- `checks` - Used to add checks to the list of checks used by rules, or to override the properties of existing checks
- The checks attribute is an array of check objects
- Each check object can contain the following attributes
Expand Down

0 comments on commit 96a1ea8

Please sign in to comment.