Skip to content

Commit

Permalink
Merge pull request #214 from norgeous/docs-param-order
Browse files Browse the repository at this point in the history
  • Loading branch information
Abhinaba Ghosh authored Apr 23, 2023
2 parents d160019 + 498c976 commit 35ddcb4
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,16 +118,16 @@ The `detailedReport` key is a boolean whether to print the more detailed report

The `verbose` key is a boolean to whether to print the message `No accessibility violations detected!` when there aren't accessibility violations present in the test. For the `DefaultTerminalReporter` this is true and for the `v2 Reporter` this is false.

##### skipFailures (optional, defaults to false)

Disables assertions based on violations and only logs violations to the console output. If you set `skipFailures` as `true`, although accessibility check is not passed, your test will not fail. It will simply print the violations in the console, but will not make the test fail.

##### reporter (optional)

A class instance that implements the `Reporter` interface or values `default`, `v2` and `html`. Custom reporter instances can be supplied to override default reporting behaviour dictated by `DefaultTerminalReporter` set by the value `default`. `v2` is the new TerminalReporter inspired by the reports from [jest-axe](https://github.com/nickcolley/jest-axe). `html` reporter will generate external HTML file.

Note! `html` reporter will disable printed to logs violations.

##### skipFailures (optional, defaults to false)

Disables assertions based on violations and only logs violations to the console output. If you set `skipFailures` as `true`, although accessibility check is not passed, your test will not fail. It will simply print the violations in the console, but will not make the test fail.

##### options (dedicated for axe-html-reporter)

Options dedicated for HTML reporter.
Expand Down

0 comments on commit 35ddcb4

Please sign in to comment.