Référence de l'API axe DevTools Node Logger
Référence API pour le package @axe-devtools/logger
Ce document décrit les méthodes implémentées par la classe AxeDevToolsLogger dans le package @axe-devtools/logger.
Constructeur
Crée un enregistreur axe DevTools que vous pouvez utiliser pour écrire un fichier de résultats JSON dans le répertoire spécifié. Vous pouvez utiliser l'API Reporter pour générer des rapports dans plusieurs formats différents à partir de ce fichier de résultats.
constructor(reportName: string, directory?: string)Exemple d'utilisation :
let logger = new AxeDevToolsLogger("Report Name", "directory-name");Étant donné que la classe AxeDevToolsReporter hérite de cette classe, vous appelez généralement les méthodes de la classe AxeDevToolsLogger via votre instance AxeDevToolsReporter .
Paramètres
| Nom | Type | Description |
|---|---|---|
| Nom du rapport | string | Le nom du rapport, qui sera la première partie du nom du fichier de résultats de sortie. |
| répertoire | Chaîne (facultatif) | Le répertoire dans lequel l'API du logger écrira le fichier de résultats JSON |
Méthodes
| Nom | Description |
|---|---|
| getTestResults | Renvoie un tableau de résultats de test. |
| logTestResult | Enregistrer les résultats des tests. |
getTestResults
Renvoie un tableau de résultats de tests axe DevTools. Les résultats peuvent être filtrés par userAgent.
public getTestResults(userAgent?: string): AxeDevToolsResults[] Paramètres
| Nom | Type | Description |
|---|---|---|
| Agent utilisateur | Chaîne (facultatif) | Spécifie l' userAgent pour filtrer les résultats. Seuls les résultats pour lesquels le userAgent correspond seront écrits sur le disque. |
Retours
Un tableau de AxeDevToolsResults
logTestResult
Enregistre le résultat d'accessibilité actuel sur le disque. Voir Exemples de code Reporter pour des exemples de code.
public logTestResult(
id: string,
finding: Findings,
options?: LogTestResultOptions
): void
Paramètres
| Nom | Type | Description |
|---|---|---|
| id | string | Un identifiant fourni par l'utilisateur pour la constatation |
| constatation | Objet de Constatations | L'objet Constatations obtenu à partir de l'exécution d'un test, généralement un objet results de run() ou analyze() |
| options | Objet LogTestResultsOptions (facultatif) | Options de configuration de l'enregistreur |
Aller-retour
Rien n'est retourné