axe DevTools Node Reporter API-Referenz

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

API-Referenz für das Paket @axe-devtools/reporter

Not for use with personal data

Dieses Dokument beschreibt die von der Klasse AxeDevToolsReporter bereitgestellten Methoden.

Die Klasse AxeDevToolsReporter erweitert die Klasse AxeDevToolsLogger (aus dem Paket @axe-devtools/logger), sodass Sie eine Instanz von AxeDevToolsReporter erstellen und von der Klasse AxeDevToolsLogger angebotene Methoden aufrufen können. Weitere Informationen zu den von der Klasse (node-logger-reference) axe DevTools Logger bereitgestellten Methoden finden Sie in der [axe DevTools Logger-Referenz] .

Konstruktor

constructor(reportName: string, directory?: string)

Anwendungsbeispiel:

const axeReporter = new AxeDevToolsReporter("AxeDevTools-Results", "./test-results/");

Parameter

Name Art Beschreibung
Berichtsname String Der Titel des Berichts. Der Wert reportName wird das erste Segment des Dateinamens der JSON-Ergebnisse werden.
Verzeichnis Zeichenfolge (optional) Verzeichnis, in dem der Bericht geschrieben wird. Verzeichnisse werden rekursiv erstellt, sofern sie noch nicht vorhanden sind.

Methoden

Jede dieser Methoden erstellt den angegebenen Bericht aus der JSON-Ergebnisdatei, die von der Methode logTestResult erstellt wird.

Name Beschreibung
CSV erstellen Erstellen eines CSV-Berichts
HTML erstellen Erstellen eines HTML-Berichts
JUnitXML erstellen Erstellen eines XML-Berichts

CSV erstellen

Erstellt eine CSV-Datei aus der JSON-Ergebnisdatei, die mit der Methode logTestResult erstellt wurde.

buildCSV(directory: string, userAgent?: string, filterOpts?: string[]): Promise<void>;

Parameter

Name Art Beschreibung
Verzeichnis String Das Verzeichnis zum Erstellen der CSV-Ausgabedatei. Alle Verzeichnisse werden rekursiv erstellt, sofern sie noch nicht vorhanden sind.
userAgent Zeichenfolge (optional) In der CSV-Datei werden nur Ergebnisse mit dem angegebenen Benutzeragenten angezeigt.
filterOpts Array von Zeichenfolgen (optional) Eine Reihe von Filteroptionen zur Auswahl der Ergebnisse.

Rückgabewert

Promise<void>

Erstellen HTML

Erstellt aus der JSON-Datei mit den Barrierefreiheitsergebnissen eine HTML-Datei im angegebenen Verzeichnis.

buildHTML(directory: string, userAgent?: string): Promise<void>;

Parameter

Name Art Beschreibung
Verzeichnis String Das Verzeichnis zum Erstellen der HTML-Ausgabedatei. Alle Verzeichnisse werden rekursiv erstellt, sofern sie noch nicht vorhanden sind.
userAgent Zeichenfolge (optional) In der HTML-Berichtsdatei werden nur Ergebnisse mit dem angegebenen Benutzeragenten angezeigt.

Rückgabewert

Promise<void>

buildJUnitXML

Erstellt eine JUnit-XML-Datei im angegebenen Verzeichnis aus den JSON-Zugänglichkeitsergebnissen.

buildJUnitXML(directory: string, userAgent?: string): Promise<void>;

Parameter

Name Art Beschreibung
Verzeichnis String Das Verzeichnis zum Erstellen der XML-Ausgabedatei. Alle Verzeichnisse werden rekursiv erstellt, sofern sie noch nicht vorhanden sind.
userAgent Zeichenfolge (optional) In der XML-Berichtsdatei werden nur Ergebnisse mit dem angegebenen Benutzeragenten angezeigt.

Rückgabewert

Promise<void>

Is this page helpful?

Help us improve this page

Still need help?