Axe DevTools Node Reporter API-Referenz
API-Referenz für das @axe-devtools/reporter-Paket
Dieses Dokument beschreibt die Methoden, die von der AxeDevToolsReporter -Klasse bereitgestellt werden.
Die AxeDevToolsReporter -Klasse erweitert die AxeDevToolsLogger -Klasse (aus dem @axe-devtools/logger-Paket), sodass Sie eine Instanz von AxeDevToolsReporter erstellen und Methoden aufrufen können, die von der AxeDevToolsLogger -Klasse angeboten werden. Siehe die Axe DevTools Logger-Referenz für weitere Informationen zu den von der AxeDevToolsLogger -Klasse bereitgestellten Methoden.
Konstruktor
constructor(reportName: string, directory?: string)Beispiel für die Verwendung:
const axeReporter = new AxeDevToolsReporter("AxeDevTools-Results", "./test-results/");Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| reportName | string | Der Titel des Berichts. Der reportName -Wert wird das erste Segment des Dateinamens der JSON-Ergebnisse. |
| directory | string (optional) | Verzeichnis, in dem der Bericht gespeichert wird. Verzeichnisse werden rekursiv erstellt, wenn sie noch nicht vorhanden sind. |
Methoden
Jede dieser Methoden erstellt den angegebenen Bericht aus der JSON-Ergebnisdatei, die von der logTestResult -Methode erzeugt wird.
| Name | Beschreibung |
|---|---|
| buildCSV | Erstellt einen CSV-Bericht |
| buildEARL | Erstellt einen W3C EARL JSON-LD-Bericht |
| buildHTML | Erstellt einen HTML-Bericht |
| buildJUnitXML | Erstellt einen XML-Bericht |
buildCSV
Erstellt eine CSV-Datei aus der Ergebnis-JSON-Datei, die von der logTestResult -Methode erstellt wurde.
buildCSV(directory: string, userAgent?: string, filterOpts?: string[]): Promise<void>;Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| Verzeichnis | Zeichenkette | Das Verzeichnis zum Erstellen der Ausgabedatei im .csv-Format. Alle Verzeichnisse werden rekursiv erstellt, falls sie nicht bereits existieren. |
| userAgent | Zeichenkette (optional) | Nur Ergebnisse mit dem angegebenen User-Agent werden in der .csv-Datei erscheinen |
| filterOpts | Array von Zeichenketten (optional) | Ein Array von Filteroptionen zur Auswahl der Ergebnisse. |
Rückgaben
Promise<void>buildEARL
Erstellt eine W3C EARL (Evaluation and Report Language) JSON-LD-Datei mit dem Namen axe-devtools-results.earl.json im angegebenen Verzeichnis.
EARL-Ausgaben unterstützen keine Ergebnisse von Axe DevTools Mobile. Wenn mobile Ergebnisse vorhanden sind, buildEARL wird ein Fehler angezeigt, bevor eine Datei geschrieben wird.
buildEARL(directory: string, userAgent?: string): Promise<void>;Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| Verzeichnis | Zeichenkette | Das Verzeichnis zum Erstellen der Ausgabedatei .earl.json . Alle Verzeichnisse werden rekursiv erstellt, falls sie nicht bereits existieren. |
| userAgent | Zeichenkette (optional) | Nur Ergebnisse mit dem angegebenen User-Agent erscheinen im EARL-Bericht |
Rückgaben
Promise<void>buildHTML
Erstellt eine HTML-Datei im angegebenen Verzeichnis aus der JSON-Datei mit den Barrierefreiheitsergebnissen.
buildHTML(directory: string, userAgent?: string): Promise<void>;Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| Verzeichnis | Zeichenkette | Das Verzeichnis zum Erstellen der Ausgabedatei im .html-Format. Alle Verzeichnisse werden rekursiv erstellt, falls sie nicht bereits existieren. |
| userAgent | Zeichenkette (optional) | Nur Ergebnisse mit dem angegebenen User-Agent erscheinen in der .html-Berichtsdatei |
Rückgaben
Promise<void>buildJUnitXML
Erstellt eine JUnit XML-Datei im angegebenen Verzeichnis aus den JSON-Ergebnissen zur Barrierefreiheit.
buildJUnitXML(directory: string, userAgent?: string): Promise<void>;Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| Verzeichnis | Zeichenkette | Das Verzeichnis, in dem die Ausgabe-.xml-Datei erstellt wird. Alle Verzeichnisse werden rekursiv erstellt, wenn sie noch nicht existieren. |
| Benutzeragent | Zeichenkette (optional) | Nur Ergebnisse mit dem angegebenen Benutzeragenten erscheinen in der .xml-Berichtsdatei |
Rückgaben
Promise<void>