Référence API Axe DevTools Node Reporter

Ce document décrit les méthodes fournies par la classe AxeDevToolsReporter.

La classe AxeDevToolsReporter étend la classe AxeDevToolsLogger (du package @axe-devtools/logger), vous pouvez donc créer une instance de AxeDevToolsReporter et appeler les méthodes offertes par la classe AxeDevToolsLogger. Consultez le Référence du journal Axe DevTools pour plus d'informations sur les méthodes fournies par la classe AxeDevToolsLogger.

Les signatures de méthode sur cette page sont écrites en notation TypeScript, correspondant aux déclarations de type incluses avec le package. Les exemples d'utilisation sont en JavaScript, et ils se compilent sans modification en TypeScript. Pour des versions côte à côte de JavaScript et TypeScript d'un fichier complet, voir Génération de rapports.

Constructeur

constructor(reportName: string, directory?: string)

Exemple d'utilisation :

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

Paramètres

Méthodes

Chacune de ces méthodes crée le rapport spécifié à partir du fichier JSON de résultats produit par la méthode logTestResult.

buildCSV

Crée un fichier CSV à partir du fichier JSON de résultats créé par la méthode logTestResult.

buildCSV(directory: string, userAgent?: string, filterOpts?: string[]): Promise<void>;

Paramètres

Retourne

Promise<void>

buildEARL

Crée un fichier JSON-LD en W3C EARL (Evaluation and Report Language) nommé axe-devtools-results.earl.json dans le répertoire spécifié.

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

Paramètres

Retourne

Promise<void>

buildHTML

Crée un fichier HTML dans le répertoire spécifié à partir du fichier JSON des résultats d'accessibilité.

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

Paramètres

Retourne

Promise<void>

Options de rendu

Transmis à buildHTML pour contrôler comment le rapport est pré-rendu en balisage statique. Chaque option est optionnelle, et chacune a une variable d'environnement qui s'applique lorsque l'option n'est pas définie. Le moteur de rendu est sélectionné une fois par appel, donc ces options s'appliquent à chaque rapport que cet appel génère.

La détection automatique démarre un processus de navigateur pour chaque rapport. Sur un lot important, ou sur une machine de production où démarrer un navigateur découvert par le dispositif de rapport n'est pas souhaité, réglez autoDetectBrowser sur false et fournissez soit browserPath soit installez jsdom.

buildJUnitXML

Crée un fichier XML JUnit dans le répertoire spécifié à partir des résultats d'accessibilité JSON.

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

Paramètres

Retourne

Promise<void>