axe DevTools Riferimento API Node Logger

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Riferimento API per il pacchetto @axe-devtools/logger

Not for use with personal data

Questo documento descrive i metodi implementati dalla classe AxeDevToolsLogger nel pacchetto @axe-devtools/logger.

Costruttore

Crea un logger axe DevTools che puoi utilizzare per scrivere un file di risultati JSON nella directory specificata. È possibile utilizzare la Reporter API per generare report in diversi formati da questo file di risultati.

constructor(reportName: string, directory?: string)

Esempio di utilizzo:

let logger = new AxeDevToolsLogger("Report Name", "directory-name");
note

Poiché la classe AxeDevToolsReporter eredita da questa classe, in genere si richiamano i metodi nella classe AxeDevToolsLogger tramite l'istanza AxeDevToolsReporter .

Parametri

Nome Tipo Descrizione
reportName corda Nome del report, che sarà la prima parte del nome del file dei risultati di output.
directory Stringa (facoltativo) La directory in cui l'API del logger scriverà il file dei risultati JSON

Metodi

Nome Descrizione
getTestResults Restituisce un array di risultati dei test.
risultatoDelTest Registra i risultati dei test.

getTestResults

Restituisce un array di risultati dei test di axe DevTools. I risultati possono essere filtrati per userAgent.

public getTestResults(userAgent?: string): AxeDevToolsResults[]

Parametri

Nome Tipo Descrizione
userAgent Stringa (facoltativo) Specifica l' userAgent per filtrare i risultati. Verranno scritti sul disco solo i risultati in cui userAgent corrisponde.

Valori restituiti

Una serie di AxeDevToolsResults

risultatoDelTest

Registra il risultato di accessibilità corrente sul disco. Per esempi di codice, vedere Esempi di codice del reporter .

public logTestResult(
    id: string,
    finding: Findings,
    options?: LogTestResultOptions
  ): void

Parametri

Nome Tipo Descrizione
id corda Un identificatore fornito dall'utente per il risultato
risultato Oggetto Findings L'oggetto Findings ottenuto eseguendo un test, solitamente l'oggetto results da run() o analyze()
opzioni Oggetto LogTestResultsOptions (facoltativo) Opzioni di configurazione del logger

Ritorno

Non viene restituito nulla

Is this page helpful?

Help us improve this page

Still need help?