axe DevTools Node Logger API-Referenz
API-Referenz für das Paket @axe-devtools/logger
Dieses Dokument beschreibt die von der Klasse AxeDevToolsLogger im Paket @axe-devtools/logger implementierten Methoden.
Konstruktor
Erstellt einen axe DevTools-Logger, mit dem Sie eine JSON-Ergebnisdatei in das angegebene Verzeichnis schreiben können. Mit der Reporter-API können Sie aus dieser Ergebnisdatei Berichte in verschiedenen Formaten erstellen.
constructor(reportName: string, directory?: string)Anwendungsbeispiel:
let logger = new AxeDevToolsLogger("Report Name", "directory-name");Da die AxeDevToolsReporter -Klasse von dieser Klasse erbt, rufen Sie Methoden in der AxeDevToolsLogger -Klasse normalerweise über Ihre AxeDevToolsReporter -Instanz auf.
Parameter
| Name | Art | Beschreibung |
|---|---|---|
| Berichtsname | String | Der Name des Berichts, der den ersten Teil des Namens der Ausgabeergebnisdatei bildet. |
| Verzeichnis | Zeichenfolge (optional) | Das Verzeichnis, in das die Logger-API die JSON-Ergebnisdatei schreibt |
Methoden
| Name | Beschreibung |
|---|---|
| getTestResults | Gibt ein Array mit Testergebnissen zurück. |
| logTestResult | Testergebnisse protokollieren. |
getTestResults
Gibt ein Array von axe DevTools-Testergebnissen zurück. Die Ergebnisse können nach userAgent gefiltert werden.
public getTestResults(userAgent?: string): AxeDevToolsResults[] Parameter
| Name | Art | Beschreibung |
|---|---|---|
| userAgent | Zeichenfolge (optional) | Gibt den userAgent zum Filtern der Ergebnisse an. Auf die Festplatte werden nur Ergebnisse geschrieben, bei denen der Benutzer-Agent übereinstimmt. |
Rückgaben
Ein Array von AxeDevToolsResults
logTestResult
Protokolliert das aktuelle Barrierefreiheitsergebnis auf der Festplatte. Codebeispiele finden Sie unter Reporter-Codebeispiele .
public logTestResult(
id: string,
finding: Findings,
options?: LogTestResultOptions
): void
Parameter
| Name | Art | Beschreibung |
|---|---|---|
| id | String | Eine vom Benutzer bereitgestellte Kennung für den Befund |
| Befund | Befunde-Objekt | Das durch Ausführen eines Tests erhaltene Befunde -Objekt, normalerweise Ergebnisse -Objekt von run() oder analyze() |
| Optionen | LogTestResultsOptions-Objekt (optional) | Logger-Konfigurationsoptionen |
Rückfahrt
Es wird nichts zurückgegeben