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 @axe-devtools/reporter-Paket

Not for use with personal data

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. Weitere Informationen zu den von der AxeDevToolsLogger-Klasse bereitgestellten Methoden finden Sie in der Axe DevTools Logger-Referenz.

Methodensignaturen auf dieser Seite sind in TypeScript-Notation verfasst, entsprechend den mit dem Paket gebündelten Typdeklarationen. Die Anwendungsbeispiele sind in JavaScript und können unverändert in TypeScript kompiliert werden. Für JavaScript- und TypeScript-Versionen einer vollständigen Datei nebeneinander sehen Sie Berichte erstellen.

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 Wert für reportName wird das erste Segment des Dateinamens für die 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 erstellt 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 von der logTestResult-Methode erstellten JSON-Ergebnisdatei.

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

Parameter

Name Typ Beschreibung
directory string Das Verzeichnis zur Erstellung der Ausgabedatei .csv. Alle Verzeichnisse werden rekursiv erstellt, wenn sie noch nicht existieren.
userAgent string (optional) Nur Ergebnisse mit dem angegebenen User-Agent erscheinen in der .csv-Datei
filterOpts string[] (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.

note

EARL-Ausgaben unterstützen keine Axe DevTools Mobile-Ergebnisse. Sind mobile Ergebnisse vorhanden, wirft buildEARL einen Fehler, bevor eine Datei geschrieben wird.

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

Parameter

Name Typ Beschreibung
directory string Das Verzeichnis zur Erstellung der Ausgabedatei .earl.json. Alle Verzeichnisse werden rekursiv erstellt, wenn sie noch nicht existieren.
userAgent string (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, renderOptions?: RenderOptions): Promise<void>;

Parameter

Name Typ Beschreibung
directory string Das Verzeichnis zur Erstellung der Ausgabedatei .html. Alle Verzeichnisse werden rekursiv erstellt, wenn sie noch nicht existieren.
userAgent string (optional) Nur Ergebnisse mit dem angegebenen User-Agent erscheinen in der .html-Berichtsdatei
renderOptions RenderOptions (optional) Steuert, wie der Bericht in statisches Markup vorrendert wird. Siehe Vorrendern von HTML-Berichten.

Rückgaben

Promise<void>

RenderOptionen

Wird an buildHTML übergeben, um zu steuern, wie der Bericht in statisches Markup vorrendert wird. Jede Option ist optional und jede hat eine Umgebungsvariable, die angewendet wird, wenn die Option nicht gesetzt ist. Der Renderer wird einmal pro Aufruf ausgewählt, sodass diese Optionen für jeden Bericht gelten, den der Aufruf erstellt.

Name Typ Standard Beschreibung
browserPath string keine Pfad zu einem Browser-Executable, das zum Vorrendern des Berichts verwendet wird. Umgebungsvariable: AXE_DEVTOOLS_REPORTER_BROWSER_PATH.
autoDetectBrowser boolean true Ob nach einem Chromium-basierten Browser gesucht werden soll, der bereits auf diesem Computer installiert ist, wenn kein Browserpfad angegeben ist und jsdom nicht installiert ist. Setzen Sie ihn auf false, um das Vorrendern zu überspringen, anstatt einen vom Reporter selbst entdeckten Browser auszuführen. Umgebungsvariable: AXE_DEVTOOLS_REPORTER_BROWSER_AUTO_DETECT.
noSandbox boolean false Deaktiviert die Browser-Sandbox. Lassen Sie die Sandbox aktiviert, es sei denn, Sie befinden sich in einer vertrauenswürdigen, eingeschränkten Umgebung, die sie nicht unterstützen kann. Umgebungsvariable: AXE_DEVTOOLS_REPORTER_BROWSER_NO_SANDBOX.
maxBufferBytes number 67108864 (64 MB) Maximale Menge des gerenderten Outputs, die aus dem Browser gepuffert wird. Erhöhen Sie dies, wenn ein großer Bericht mit einem Pufferüberlauffehler nicht gerendert werden kann.
virtualTimeBudgetMs number 5000 Wie lange der Browser zum Rendern des Berichts Zeit hat, bevor dessen Inhalt erfasst wird. Erhöhen Sie dies, wenn ein großer Bericht ohne seinen Inhalt geschrieben wird.
renderTimeoutMs number 30000 Zeitlimit für das Renderer des Browsers. Ein Browser, der nie endet, wird gestoppt und das Rendern schlägt fehl.
distDirectory string die mit dem Paket enthaltene Kopie Verzeichnis, das die Client-Ressourcen des Berichts enthält. Setzen Sie dies nur, wenn die Dateien des Pakets nicht dort sind, wo die eigene Modulauflösung sie erwartet, z.B. wenn Ihre Anwendung in eine einzige ausführbare Datei gebündelt ist.
note

Der Browser wird nur verwendet, wenn der Pfad auf eine Datei auflöst, die existiert. Wenn Sie browserPath (oder AXE_DEVTOOLS_REPORTER_BROWSER_PATH) auf einen Pfad setzen, der nicht existiert, wechselt der Reporter zur nächsten Render-Methode anstatt einen Fehler zu melden, daher überprüfen Sie den Pfad, wenn eine Fehleinstellung sichtbar werden soll.

Die automatische Erkennung startet für jeden Bericht einen Browser-Prozess. Bei einem großen Batchlauf oder auf einem Build-Server, auf dem der selbst entdeckte Start eines Browsers des Reporters unerwünscht ist, setzen Sie autoDetectBrowser auf false und geben entweder browserPath an oder installieren Sie jsdom.

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
directory string Das Verzeichnis zur Erstellung der Ausgabedatei .xml. Alle Verzeichnisse werden rekursiv erstellt, wenn sie noch nicht existieren.
userAgent string (optional) Nur Ergebnisse mit dem angegebenen User-Agent erscheinen in der .xml-Berichtsdatei

Rückgaben

Promise<void>

Is this page helpful?

Help us improve this page

Still need help?