axe DevTools Node Reporter API Riferimento
Riferimento API per il pacchetto @axe-devtools/reporter
Questo documento descrive i metodi forniti dalla classe AxeDevToolsReporter .
La classe AxeDevToolsReporter estende la classe AxeDevToolsLogger (dal pacchetto @axe-devtools/logger), così puoi creare un'istanza di AxeDevToolsReporter e chiamare i metodi offerti dalla classe AxeDevToolsLogger . Per ulteriori informazioni sui metodi forniti dalla classe AxeDevToolsLogger, consultare (node-logger-reference) [axe DevTools Logger Reference] **** .
Costruttore
constructor(reportName: string, directory?: string)Esempio di utilizzo:
const axeReporter = new AxeDevToolsReporter("AxeDevTools-Results", "./test-results/");Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| reportName | corda | Il titolo del rapporto. Il valore reportName diventerà il primo segmento del nome file dei risultati JSON. |
| directory | Stringa (facoltativo) | Directory in cui verrà redatto il report. Se non esistono già, le directory verranno create in modo ricorsivo. |
Metodi
Ciascuno di questi metodi crea il report specificato dal file JSON dei risultati prodotto dal metodo logTestResult .
| Nome | Descrizione |
|---|---|
| buildCSV | Crea un report CSV |
| buildHTML | Crea un rapporto HTML |
| buildJUnitXML | Crea un rapporto XML |
buildCSV
Crea un file CSV dal file JSON dei risultati creato dal metodo logTestResult .
buildCSV(directory: string, userAgent?: string, filterOpts?: string[]): Promise<void>;Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
| directory | corda | La directory in cui creare il file .csv di output. Tutte le directory, se non esistono già, verranno create ricorsivamente. |
| userAgent | Stringa (facoltativo) | Nel file .csv appariranno solo i risultati con il userAgent specificato |
| filterOpts | Array di stringhe (facoltativo) | Una serie di opzioni di filtro per selezionare i risultati. |
Restituisce
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 | corda | La directory in cui creare il file .html di output. Tutte le directory, se non esistono già, verranno create ricorsivamente. |
| userAgent | Stringa (facoltativo) | Nel file di report .html appariranno solo i risultati con il user agent specificato |
Restituisce
Promise<void>costruisciJUnitXML
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 | corda | La directory in cui creare il file .xml di output. Tutte le directory, se non esistono già, verranno create ricorsivamente. |
| userAgent | Stringa (facoltativo) | Nel file di report .xml verranno visualizzati solo i risultati con il user agent specificato |
Restituisce
Promise<void>