Référence API Axe DevTools Node Reporter
Référence API pour le package @axe-devtools/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 . Voir la Référence Logger axe DevTools pour plus d'informations sur les méthodes fournies par la classe AxeDevToolsLogger .
Constructeur
constructor(reportName: string, directory?: string)Exemple d'utilisation :
const axeReporter = new AxeDevToolsReporter("AxeDevTools-Results", "./test-results/");Paramètres
| Nom | Type | Description |
|---|---|---|
| reportName | string | Le titre du rapport. La valeur de reportName deviendra le premier segment du nom de fichier des résultats JSON. |
| directory | string (optionnel) | Répertoire où le rapport sera écrit. Les répertoires seront créés de manière récursive s'ils n'existent pas déjà. |
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 .
| Nom | Description |
|---|---|
| buildCSV | Créer un rapport CSV |
| buildEARL | Créer un rapport W3C EARL JSON-LD |
| buildHTML | Créer un rapport HTML |
| buildJUnitXML | Créer un rapport XML |
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
| Nom | Type | Description |
|---|---|---|
| répertoire | chaîne | Le répertoire dans lequel créer le fichier de sortie .csv. Tous les répertoires seront créés récursivement s'ils n'existent pas déjà. |
| userAgent | chaîne (optionnel) | Seuls les résultats avec l'agent utilisateur spécifié apparaîtront dans le fichier .csv |
| filterOpts | tableau de chaînes (optionnel) | Un tableau d'options de filtrage pour sélectionner les résultats. |
Retours
Promise<void>buildEARL
Crée un fichier JSON-LD EARL (Evaluation and Report Language) W3C nommé axe-devtools-results.earl.json dans le répertoire spécifié.
La sortie EARL ne prend pas en charge les résultats d'Axe DevTools Mobile. Si des résultats mobiles sont présents, buildEARL génère une erreur avant d'écrire un fichier.
buildEARL(directory: string, userAgent?: string): Promise<void>;Paramètres
| Nom | Type | Description |
|---|---|---|
| répertoire | chaîne | Le répertoire dans lequel créer le fichier de sortie .earl.json . Tous les répertoires seront créés récursivement s'ils n'existent pas déjà. |
| userAgent | chaîne (optionnel) | Seuls les résultats avec l'agent utilisateur spécifié apparaîtront dans le rapport EARL |
Retours
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): Promise<void>;Paramètres
| Nom | Type | Description |
|---|---|---|
| répertoire | chaîne | Le répertoire dans lequel créer le fichier de sortie .html. Tous les répertoires seront créés récursivement s'ils n'existent pas déjà. |
| userAgent | chaîne (optionnel) | Seuls les résultats avec l'agent utilisateur spécifié apparaîtront dans le fichier rapport .html |
Retours
Promise<void>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
| Nom | Type | Description |
|---|---|---|
| répertoire | chaîne | Le répertoire pour créer le fichier de sortie .xml. Tous les répertoires seront créés récursivement s'ils n'existent pas déjà. |
| agentUtilisateur | chaîne (facultatif) | Seuls les résultats avec l'agent utilisateur spécifié apparaîtront dans le fichier rapport .xml |
Retourne
Promise<void>