Axe DevTools Node Logger API-referentie
API-referentie voor het @axe-devtools/logger-pakket
Dit document beschrijft de methoden geïmplementeerd door de AxeDevToolsLogger-klasse in het @axe-devtools/logger-pakket.
Constructor
Maakt een Axe DevTools logger die u kunt gebruiken om een JSON-resultatenbestand in de opgegeven map te schrijven. U kunt de Reporter API gebruiken om rapporten in verschillende formaten te genereren vanuit dit resultatenbestand.
constructor(reportName: string, directory?: string)Voorbeeldgebruik:
let logger = new AxeDevToolsLogger("Report Name", "directory-name");Omdat de AxeDevToolsReporter-klasse van deze klasse erft, roept u doorgaans methoden in de AxeDevToolsLogger-klasse aan via uw AxeDevToolsReporter-instantie.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
| reportName | string | De naam van het rapport, dat het eerste deel van de uitkomstbestandsnaam zal zijn. |
| directory | string (optioneel) | De map waarin de logger-API het JSON-resultatenbestand zal schrijven |
Methoden
| Naam | Beschrijving |
|---|---|
| getTestResults | Geeft een array van testresultaten terug. |
| logTestResult | Log testresultaten. |
getTestResults
Geeft een array van Axe DevTools-testresultaten terug. De resultaten kunnen worden gefilterd door userAgent.
public getTestResults(userAgent?: string): AxeDevToolsResults[] Parameters
| Naam | Type | Beschrijving |
|---|---|---|
| userAgent | string (optioneel) | Specificeert de userAgent voor het filteren van de resultaten. Alleen resultaten waarbij de userAgent overeenkomt, worden op schijf geschreven. |
Keert terug
Een array van AxeDevToolsResults
logTestResult
Logt het huidige toegankelijkheidsresultaat naar schijf. Zie Voorbeelden van reportercode voor codevoorbeelden.
public logTestResult(
id: string,
finding: Findings,
options?: LogTestResultOptions
): void
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
| id | tekenreeks | Een door de gebruiker geleverde identificator voor de bevinding |
| bevinding | Bevindingenobject | Het Bevindingen-object verkregen door een test uit te voeren, meestal een resultaten-object van run() of analyze() |
| opties | LogTestResultsOptions-object (optioneel) | Opties voor loggerconfiguratie |
Terugkeerwaarde
Er wordt niets geretourneerd