From 96a1ea88eb56b556d66bf69f3c68d6f965ca6d69 Mon Sep 17 00:00:00 2001 From: Steven Lambert Date: Mon, 10 Jun 2019 14:44:48 -0600 Subject: [PATCH] docs: add all reporters to axe.configure parameters (#1626) --- doc/API.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/API.md b/doc/API.md index eae601b075..4ad1388dd5 100644 --- a/doc/API.md +++ b/doc/API.md @@ -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