Axe DevTools Node Reporter API-referentie
API-referentie voor het @axe-devtools/reporter-pakket
Dit document beschrijft de methoden die worden geleverd door de AxeDevToolsReporter-klasse.
De AxeDevToolsReporter-klasse breidt de AxeDevToolsLogger-klasse uit (van het @axe-devtools/logger pakket), zodat je een instantie van AxeDevToolsReporter kunt maken en methoden kunt aanroepen die worden aangeboden door de AxeDevToolsLogger-klasse. Zie de Axe DevTools Logger Referentie voor meer informatie over de methoden die worden geleverd door de AxeDevToolsLogger-klasse.
Constructor
constructor(reportName: string, directory?: string)Voorbeeld van gebruik:
const axeReporter = new AxeDevToolsReporter("AxeDevTools-Results", "./test-results/");Parameters
| Naam | Type | Beschrijving |
|---|---|---|
| reportName | tekenreeks | De titel van het rapport. De reportName-waarde wordt het eerste segment van de bestandsnaam van de JSON-resultaten. |
| directory | tekenreeks (optioneel) | Directory waar het rapport zal worden geschreven. Directories worden recursief aangemaakt als ze nog niet bestaan. |
Methoden
Elk van deze methoden creëert het gespecificeerde rapport uit de JSON-resultatenbestanden die worden geproduceerd door de logTestResult-methode.
| Naam | Beschrijving |
|---|---|
| buildCSV | Maak een CSV-rapport |
| buildEARL | Maak een W3C EARL JSON-LD-rapport |
| buildHTML | Maak een HTML-rapport |
| buildJUnitXML | Maak een XML-rapport |
buildCSV
Creëert een CSV-bestand van het JSON-resultatenbestand dat is aangemaakt door de logTestResult-methode.
buildCSV(directory: string, userAgent?: string, filterOpts?: string[]): Promise<void>;Parameters
| Naam | Type | Beschrijving |
|---|---|---|
| directory | tekenreeks | De directory waarin het uitvoer .csv-bestand wordt aangemaakt. Alle directories worden recursief aangemaakt als ze nog niet bestaan. |
| userAgent | tekenreeks (optioneel) | Alleen resultaten met de gespecificeerde user agent verschijnen in het .csv-bestand. |
| filterOpts | array van strings (optioneel) | Een reeks filteropties voor het selecteren van resultaten. |
Retourneert
Promise<void>buildEARL
Creëert een W3C EARL (Evaluation and Report Language) JSON-LD bestand met de naam axe-devtools-results.earl.json in de opgegeven map.
EARL-uitvoer ondersteunt geen resultaten van Axe DevTools Mobile. Als er mobiele resultaten aanwezig zijn, geeft buildEARL een foutmelding voordat er een bestand wordt geschreven.
buildEARL(directory: string, userAgent?: string): Promise<void>;Parameters
| Naam | Type | Beschrijving |
|---|---|---|
| directory | tekenreeks | De directory om het .earl.json-uitvoerbestand aan te maken. Alle directories worden recursief aangemaakt als ze nog niet bestaan. |
| userAgent | tekenreeks (optioneel) | Alleen resultaten met de gespecificeerde user agent verschijnen in het EARL-rapport. |
Retourneert
Promise<void>buildHTML
Maakt een HTML-bestand in de gespecificeerde directory van het toegankelijkheidsresultaten-JSON-bestand.
buildHTML(directory: string, userAgent?: string): Promise<void>;Parameters
| Naam | Type | Beschrijving |
|---|---|---|
| directory | tekenreeks | De directory waarin het uitvoer .html-bestand wordt aangemaakt. Alle directories worden recursief aangemaakt als ze nog niet bestaan. |
| userAgent | tekenreeks (optioneel) | Alleen resultaten met de gespecificeerde user agent verschijnen in het .html rapportbestand. |
Retourneert
Promise<void>buildJUnitXML
Maakt een JUnit XML-bestand in de gespecificeerde directory van de JSON-toegankelijkheidsresultaten.
buildJUnitXML(directory: string, userAgent?: string): Promise<void>;Parameters
| Naam | Type | Beschrijving |
|---|---|---|
| directory | tekenreeks | De directory om het uitvoer .xml-bestand aan te maken. Alle directories worden recursief aangemaakt als ze nog niet bestaan. |
| userAgent | tekenreeks (optioneel) | Alleen resultaten met de gespecificeerde user agent zullen in het .xml-rapportbestand verschijnen. |
Retourneert
Promise<void>