Référence de l'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 proposées par la classe AxeDevToolsLogger . Consultez la référence axe DevTools Logger 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 |
|---|---|---|
| Nom du rapport | string | Le titre du rapport. La valeur reportName deviendra le premier segment du nom de fichier des résultats JSON. |
| répertoire | Chaîne (facultatif) | Répertoire où le rapport sera rédigé. 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 |
| 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 | string | Le répertoire pour créer le fichier .csv de sortie. Tous les répertoires seront créés de manière récursive s'ils n'existent pas déjà. |
| Agent utilisateur | Chaîne (facultatif) | Seuls les résultats avec l'agent utilisateur spécifié apparaîtront dans le fichier .csv |
| Options de filtrage | Tableau de chaînes (facultatif) | Un éventail d’options de filtrage pour sélectionner les résultats. |
Renvoie
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 | string | Le répertoire pour créer le fichier .html de sortie. Tous les répertoires seront créés de manière récursive s'ils n'existent pas déjà. |
| Agent utilisateur | Chaîne (facultatif) | Seuls les résultats avec l'agent utilisateur spécifié apparaîtront dans le fichier de rapport .html |
Renvoie
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 | string | Le répertoire pour créer le fichier .xml de sortie. Tous les répertoires seront créés de manière récursive s'ils n'existent pas déjà. |
| Agent utilisateur | Chaîne (facultatif) | Seuls les résultats avec l'agent utilisateur spécifié apparaîtront dans le fichier de rapport .xml |
Renvoie
Promise<void>