Riferimento all'API di Axe DevTools Node Reporter
Riferimento all'API per il pacchetto @axe-devtools/reporter
Questo documento descrive i metodi forniti dalla classe AxeDevToolsReporter.
La classe AxeDevToolsReporter estende la classe classe AxeDevToolsLogger (del pacchetto @axe-devtools/logger), quindi puoi creare un'istanza di AxeDevToolsReporter e chiamare i metodi offerti dalla classe classe AxeDevToolsLogger. Consulta il Riferimento per Axe DevTools Logger per maggiori informazioni sui metodi forniti dalla classe classe AxeDevToolsLogger.
Costruttore
constructor(reportName: string, directory?: string)Esempio di utilizzo:
const axeReporter = new AxeDevToolsReporter("AxeDevTools-Results", "./test-results/");Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| reportName | stringa | Il titolo del report. Il valore reportName diventerà il primo segmento del nome del file dei risultati JSON. |
| directory | stringa (opzionale) | Directory in cui verrà scritto il report. Le directory verranno create ricorsivamente se non esistono già. |
Metodi
Ciascuno di questi metodi crea il report specificato dal file JSON dei risultati prodotto dal metodo metodo logTestResult.
| Nome | Descrizione |
|---|---|
| buildCSV | Crea un report CSV |
| buildEARL | Crea un report JSON-LD W3C EARL |
| buildHTML | Crea un report HTML |
| buildJUnitXML | Crea un report XML |
buildCSV
Crea un file CSV dal file JSON dei risultati creato dal metodo metodo logTestResult.
buildCSV(directory: string, userAgent?: string, filterOpts?: string[]): Promise<void>;Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| directory | stringa | La directory per creare il file di output .csv. Tutte le directory verranno create ricorsivamente se non esistono già. |
| userAgent | stringa (opzionale) | Solo i risultati con l'user agent specificato appariranno nel file .csv |
| filterOpts | array di stringhe (opzionale) | Un array di opzioni di filtro per selezionare i risultati. |
Risultati
Promise<void>buildEARL
Crea un file JSON-LD W3C EARL (Evaluation and Report Language) denominato axe-devtools-results.earl.json nella directory specificata.
L'output EARL non supporta i risultati di Axe DevTools Mobile. Se sono presenti risultati mobili, buildEARL genera un errore prima di scrivere qualsiasi file.
buildEARL(directory: string, userAgent?: string): Promise<void>;Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| directory | stringa | La directory per creare il file .earl.json di output. Tutte le directory verranno create ricorsivamente se non esistono già. |
| userAgent | stringa (opzionale) | Solo i risultati con l'user agent specificato appariranno nel report EARL |
Risultati
Promise<void>buildHTML
Crea un file HTML nella directory specificata dal file JSON dei risultati di accessibilità.
buildHTML(directory: string, userAgent?: string): Promise<void>;Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| directory | stringa | La directory per creare il file di output .html. Tutte le directory verranno create ricorsivamente se non esistono già. |
| userAgent | stringa (opzionale) | Solo i risultati con l'user agent specificato appariranno nel file di report .html |
Risultati
Promise<void>buildJUnitXML
Crea un file XML JUnit nella directory specificata dai risultati di accessibilità JSON.
buildJUnitXML(directory: string, userAgent?: string): Promise<void>;Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| directory | stringa | La directory in cui creare il file di output .xml. Tutte le directory verranno create ricorsivamente se non esistono già. |
| userAgent | stringa (opzionale) | Solo i risultati con l'agent utente specificato appariranno nel file di report .xml. |
Risultati
Promise<void>