Riferimento API Logger Node di Axe DevTools
Riferimento API per il pacchetto @axe-devtools/logger
Questo documento descrive i metodi implementati dalla classe AxeDevToolsLogger nel pacchetto @axe-devtools/logger.
Le firme dei metodi in questa pagina sono scritte nella notazione TypeScript, in linea con le dichiarazioni di tipo incluse nel pacchetto. Gli esempi di utilizzo sono in JavaScript e vengono compilati senza modifiche in TypeScript. Per la sintassi di importazione in ciascuna lingua, vedere Log con Axe DevTools Node API.
Costruttore
Crea un logger Axe DevTools che puoi utilizzare per scrivere un file di risultati JSON nella directory specificata. Puoi usare il API del Reporter per generare report in diversi formati da questo file di risultati.
constructor(reportName: string, directory?: string)Esempio di utilizzo:
let logger = new AxeDevToolsLogger("Report Name", "directory-name");Poiché la classe AxeDevToolsReporter eredita da questa classe, di solito invoca i metodi nella classe AxeDevToolsLogger tramite la tua istanza di AxeDevToolsReporter.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| reportName | stringa | Il nome del report, che sarà la prima parte del nome del file di risultati di output. |
| directory | stringa (opzionale) | La directory in cui l'API del logger scriverà il file di risultati JSON |
Metodi
| Nome | Descrizione |
|---|---|
| getTestResults | Restituisce un array di risultati dei test. |
| logTestResult | Registra i risultati dei test. |
getTestResults
Restituisce un array di risultati dei test di Axe DevTools. I risultati possono essere filtrati per userAgent.
public getTestResults(userAgent?: string): AxeDevToolsResults[] Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| userAgent | stringa (opzionale) | Specifica il userAgent per filtrare i risultati. Solo i risultati in cui il userAgent corrisponde verranno scritti sul disco. |
Restituzioni
Un array di AxeDevToolsResults
logTestResult
Registra il risultato attuale dell'accessibilità su disco. Vedi Esempi di codice del Reporter per esempi di codice.
public logTestResult(
id: string,
finding: Findings,
options?: LogTestResultOptions
): void
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| id | stringa | Un identificatore fornito dall'utente per il risultato |
| risultato | Oggetto Risultati | L'oggetto Findings ottenuto dall'esecuzione di un test, solitamente oggetto results da run() o analyze() |
| opzioni | Oggetto LogTestResultsOptions (opzionale) | Opzioni di configurazione del logger |
Restituzione
Non viene restituito nulla