Référence de l'API Axe DevTools Node Logger
Référence de l'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.
Les signatures des méthodes 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 se compilent sans modification en TypeScript. Pour la syntaxe d'importation dans chaque langue, voir Journalisation avec les API Axe DevTools Node.
Constructeur
Crée un logger Axe DevTools que vous pouvez utiliser pour écrire un fichier de résultats JSON dans le répertoire spécifié. Vous pouvez utiliser le API de Rapport 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");Comme la classe AxeDevToolsReporter hérite de cette classe, vous invoquez généralement les méthodes de la classe AxeDevToolsLogger via votre instance AxeDevToolsReporter.
Paramètres
| Nom | Type | Description |
|---|---|---|
| nomRapport | chaîne | Le nom du rapport, qui sera la première partie du nom du fichier de résultats. |
| répertoire | chaîne (optionnel) | Le répertoire où l'API du logger écrira le fichier de résultats JSON |
Méthodes
| Nom | Description |
|---|---|
| getTestResults | Retourne un tableau de résultats de tests. |
| logTestResult | Enregistre les résultats de tests. |
getTestResults
Retourne 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 |
|---|---|---|
| userAgent | chaîne (optionnel) | Spécifie le userAgent pour filtrer les résultats. Seuls les résultats où userAgent correspond seront écrits sur le disque. |
Retourne
Un tableau de AxeDevToolsResults
logTestResult
Enregistre le résultat d'accessibilité actuel sur le disque. Voir Exemples de code de rapport pour des exemples de code.
public logTestResult(
id: string,
finding: Findings,
options?: LogTestResultOptions
): void
Paramètres
| Nom | Type | Description |
|---|---|---|
| id | chaîne | Un identifiant fourni par l'utilisateur pour la constatation |
| constatation | Objet Constations | L'objet Findings obtenu après avoir exécuté un test, généralement un objet results provenant de run() ou analyze() |
| options | Objet LogTestResultsOptions (optionnel) | Options de configuration du journal |
Retour
Rien n'est retourné