Axe DevTools Node Logger API-Referenz
API-Referenz für das @axe-devtools/logger-Paket
Dieses Dokument beschreibt die Methoden, die von der Klasse AxeDevToolsLogger im @axe-devtools/logger-Paket implementiert werden.
Methodensignaturen auf dieser Seite sind in TypeScript-Notation geschrieben und entsprechen den mit dem Paket gebündelten Typdeklarationen. Die Verwendungsbeispiele sind in JavaScript und lassen sich unverändert in TypeScript kompilieren. Für die Importsyntax in jeder Sprache siehe Protokollierung mit Axe DevTools Node APIs.
Konstruktor
Erstellt einen Axe DevTools-Logger, den Sie verwenden können, um eine JSON-Ergebnisdatei in das angegebene Verzeichnis zu schreiben. Sie können die Reporter-API verwenden, um Berichte in mehreren verschiedenen Formaten aus dieser Ergebnisdatei zu generieren.
constructor(reportName: string, directory?: string)Beispielverwendung:
let logger = new AxeDevToolsLogger("Report Name", "directory-name");Da die AxeDevToolsReporter-Klasse von dieser Klasse erbt, rufen Sie normalerweise Methoden in der AxeDevToolsLogger-Klasse über Ihre AxeDevToolsReporter-Instanz auf.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| reportName | Zeichenkette | Der Name des Berichts, der der erste Teil des Dateinamens der Ausgabedatei sein wird. |
| directory | string (optional) | Das Verzeichnis, in dem die Logger-API die JSON-Ergebnisdatei schreibt |
Methoden
| Name | Beschreibung |
|---|---|
| getTestResults | Gibt ein Array von Testergebnissen zurück. |
| logTestResult | Loggt Testergebnisse. |
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 | Typ | Beschreibung |
|---|---|---|
| userAgent | string (optional) | Gibt den userAgent zum Filtern der Ergebnisse an. Nur Ergebnisse, bei denen der userAgent übereinstimmt, werden auf die Festplatte geschrieben. |
Rückgaben
Ein Array von AxeDevToolsResults
logTestResult
Loggt das aktuelle Accessibility-Ergebnis auf die Festplatte. Siehe Reporter-Beispielcode für Beispielcode.
public logTestResult(
id: string,
finding: Findings,
options?: LogTestResultOptions
): void
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
| id | Zeichenkette | Eine vom Benutzer bereitgestellte Kennung für den Befund |
| Befund | Befunde-Objekt | Das Findings-Objekt, das aus dem Durchführen eines Tests erhalten wurde, üblicherweise results-Objekt von run() oder analyze() |
| Optionen | LogTestResultsOptions-Objekt (optional) | Konfigurationsoptionen des Loggers |
Rückgabe
Es wird nichts zurückgegeben