Riferimento all'API di Axe DevTools Node Reporter

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 all'API per il pacchetto @axe-devtools/reporter

Not for use with personal data

Questo documento descrive i metodi forniti dalla classe AxeDevToolsReporter.

La classe AxeDevToolsReporter estende la classe AxeDevToolsLogger (dal pacchetto @axe-devtools/logger), quindi puoi creare un'istanza di AxeDevToolsReporter e chiamare i metodi offerti dalla classe AxeDevToolsLogger. Consulta Riferimento per Axe DevTools Logger per ulteriori informazioni sui metodi forniti dalla classe AxeDevToolsLogger.

Le firme di metodo in questa pagina sono scritte in notazione TypeScript, corrispondente alle dichiarazioni di tipo incluse nel pacchetto. Gli esempi d'uso sono in JavaScript e vengono compilati senza modifiche in TypeScript. Per le versioni affiancate di un file completo in JavaScript e TypeScript, vedere Generazione di rapporti.

Costruttore

constructor(reportName: string, directory?: string)

Esempio di utilizzo:

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

Parametri

Nome Tipo Descrizione
reportName string Il titolo del rapporto. Il valore reportName diventerà il primo segmento del nome del file dei risultati JSON.
directory string (facoltativo) Directory in cui verrà scritto il report. Le directory verranno create ricorsivamente se non esistono già.

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
buildEARL Crea un report JSON-LD W3C EARL
buildHTML Crea un report HTML
buildJUnitXML Crea un report 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 string La directory per creare il file .csv di output. Tutte le directory verranno create ricorsivamente se non esistono già.
userAgent string (facoltativo) Solo i risultati con il user agent specificato appariranno nel file .csv
filterOpts string[] (facoltativo) Un array di opzioni di filtro per selezionare i risultati.

Risultati

Promise<void>

buildEARL

Crea un file JSON-LD W3C EARL (Evaluation and Report Language) denominato axe-devtools-results.earl.json nella directory specificata.

note

L'output EARL non supporta i risultati di Axe DevTools Mobile. Se sono presenti risultati mobili, buildEARL genera un errore prima di scrivere qualsiasi file.

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

Parametri

Nome Tipo Descrizione
directory string La directory per creare il file .earl.json di output. Tutte le directory verranno create ricorsivamente se non esistono già.
userAgent string (facoltativo) Solo i risultati con l'user agent specificato appariranno nel report EARL

Risultati

Promise<void>

buildHTML

Crea un file HTML nella directory specificata dal file JSON dei risultati di accessibilità.

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

Parametri

Nome Tipo Descrizione
directory string La directory per creare il file .html di output. Tutte le directory verranno create ricorsivamente se non esistono già.
userAgent string (facoltativo) Solo i risultati con il user agent specificato appariranno nel file di rapporto .html
renderOptions RenderOptions (facoltativo) Controlla il modo in cui il report è pre-renderizzato in markup statico. Vedi Pre-rendering dei report HTML.

Risultati

Promise<void>

Opzioni di rendering

Passato a buildHTML per controllare il modo in cui il report è pre-renderizzato in markup statico. Ogni opzione è facoltativa, e ognuna ha una variabile d'ambiente che si applica quando l'opzione non è impostata. Il renderer è selezionato una volta per chiamata, quindi queste opzioni si applicano a ogni report che quella chiamata genera.

Nome Tipo Predefinito Descrizione
browserPath string nessuno Percorso di un eseguibile del browser usato per pre-renderizzare il report. Variabile d'ambiente: AXE_DEVTOOLS_REPORTER_BROWSER_PATH.
autoDetectBrowser boolean true Se cercare un browser basato su Chromium già installato su questa macchina quando non è dato un percorso del browser e jsdom non è installato. Impostalo su false per saltare il pre-rendering anziché eseguire un browser che il reporter ha trovato. Variabile d'ambiente: AXE_DEVTOOLS_REPORTER_BROWSER_AUTO_DETECT.
noSandbox boolean false Disabilita il sandbox del browser. Lascia abilitato il sandbox a meno che tu non sia in un ambiente fidato e ristretto che non può supportarlo. Variabile d'ambiente: AXE_DEVTOOLS_REPORTER_BROWSER_NO_SANDBOX.
maxBufferBytes number 67108864 (64 MB) Quantità massima di output reso da memorizzare nel buffer dal browser. Aumenta questo valore se un report grande non riesce a essere renderizzato a causa di un errore di overflow del buffer.
virtualTimeBudgetMs number 5000 Tempo concesso al browser per rendere il report prima che il suo contenuto venga catturato. Aumenta questo valore se un report grande viene scritto senza il suo contenuto.
renderTimeoutMs number 30000 Limite di tempo per il rendering del browser. Un browser che non termina mai viene interrotto e il rendering fallisce.
distDirectory string la copia inclusa con il pacchetto Directory che contiene i contenuti del client del report. Imposta questo solo quando i file del pacchetto non si trovano dove la risoluzione del modulo del pacchetto stesso li aspetta, come quando la tua applicazione è aggregata in un unico eseguibile.
note

Il browser viene utilizzato solo quando il percorso si risolve a un file che esiste. Se imposti browserPath (o AXE_DEVTOOLS_REPORTER_BROWSER_PATH) su un percorso che non esiste, il reporter passa al metodo di rendering successivo invece di segnalare un errore, quindi verifica il percorso se hai bisogno che una configurazione errata venga rilevata.

L'auto-rilevamento avvia un processo del browser per ogni report. In un'esecuzione batch di grandi dimensioni, o su una macchina di build in cui non si desidera avviare un browser che il reporter ha trovato, imposta autoDetectBrowser su false e fornisci browserPath o installa jsdom.

buildJUnitXML

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 string La directory per creare il file .xml di output. Tutte le directory verranno create ricorsivamente se non esistono già.
userAgent string (facoltativo) Solo i risultati con il user agent specificato appariranno nel file di rapporto .xml

Risultati

Promise<void>

Is this page helpful?

Help us improve this page

Still need help?