Axe DevTools Node Reporter API-referentie

Dit document beschrijft de methoden die worden geleverd door de AxeDevToolsReporter-klasse.

De AxeDevToolsReporter klasse breidt de AxeDevToolsLogger klasse uit (uit het @axe-devtools/logger pakket), zodat je een instantie van AxeDevToolsReporter kunt maken en methoden aangeboden door de AxeDevToolsLogger klasse kunt aanroepen. Zie de Axe DevTools Logger Referentie voor meer informatie over de methoden die door de AxeDevToolsLogger klasse worden geboden.

Methodehandtekeningen op deze pagina zijn geschreven in TypeScript-notatie, overeenkomstig met de typedefinities die bij het pakket zijn meegeleverd. De gebruiksvoorbeelden zijn in JavaScript, en ze worden ongewijzigd gecompileerd in TypeScript. Voor JavaScript- en TypeScript-versies van een compleet bestand naast elkaar, zie Rapporten genereren.

Constructor

constructor(reportName: string, directory?: string)

Voorbeeld van gebruik:

const axeReporter = new AxeDevToolsReporter("AxeDevTools-Results", "./test-results/");

Parameters

Methoden

Elk van deze methoden creëert het gespecificeerde rapport uit de JSON-resultatenbestanden die worden geproduceerd door de logTestResult-methode.

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

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.

buildEARL(directory: string, userAgent?: string): Promise<void>;

Parameters

Retourneert

Promise<void>

buildHTML

Maakt een HTML-bestand in de gespecificeerde directory van het toegankelijkheidsresultaten-JSON-bestand.

buildHTML(directory: string, userAgent?: string, renderOptions?: RenderOptions): Promise<void>;

Parameters

Retourneert

Promise<void>

RenderOpties

Overgedragen aan buildHTML om te bepalen hoe het rapport wordt voorgerenderd naar statische markup. Elke optie is optioneel en heeft een omgevingsvariabele die van toepassing is wanneer de optie niet is ingesteld. De renderer wordt eenmaal per oproep geselecteerd, dus deze opties gelden voor elk rapport dat die oproep opbouwt.

Autodetectie start een browserproces voor elk rapport. Bij een grote batchverwerking, of op een buildmachine waar het ongewenst is om een browser te starten die de rapporteur zelf heeft ontdekt, stel autoDetectBrowser in op false en geef ofwel browserPath op of installeer jsdom.

buildJUnitXML

Maakt een JUnit XML-bestand in de gespecificeerde directory van de JSON-toegankelijkheidsresultaten.

buildJUnitXML(directory: string, userAgent?: string): Promise<void>;

Parameters

Retourneert

Promise<void>