Referencia de API de Axe DevTools Node Logger
Referencia de la API para el paquete @axe-devtools/logger
Este documento describe los métodos implementados por la clase AxeDevToolsLogger en el paquete @axe-devtools/logger.
Constructor
Crea un registrador de Axe DevTools que puede utilizar para escribir un archivo de resultados JSON en el directorio especificado. Puede utilizar el API del Reportero para generar informes en varios formatos diferentes a partir de este archivo de resultados.
constructor(reportName: string, directory?: string)Uso de ejemplo:
let logger = new AxeDevToolsLogger("Report Name", "directory-name");Debido a que la clase AxeDevToolsReporter hereda de esta clase, normalmente invoca métodos en la clase AxeDevToolsLogger a través de su instancia AxeDevToolsReporter.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| reportName | cadena | El nombre del informe, que será la primera parte del nombre del archivo de resultados de salida. |
| directorio | cadena (opcional) | El directorio donde la API del registrador escribirá el archivo de resultados JSON |
Métodos
| Nombre | Descripción |
|---|---|
| getTestResults | Devuelve un arreglo de resultados de prueba. |
| logTestResult | Registrar resultados de prueba. |
getTestResults
Devuelve un arreglo de resultados de prueba de Axe DevTools. Los resultados se pueden filtrar por userAgent.
public getTestResults(userAgent?: string): AxeDevToolsResults[] Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| userAgent | cadena (opcional) | Especifica el userAgent para filtrar los resultados. Solo los resultados donde el userAgent coincida se escribirán en el disco. |
Devuelve
Un arreglo de AxeDevToolsResults
logTestResult
Registra el resultado actual de accesibilidad en el disco. Vea Ejemplos de Código del Reportero para ejemplos de código.
public logTestResult(
id: string,
finding: Findings,
options?: LogTestResultOptions
): void
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| id | cadena | Un identificador proporcionado por el usuario para el hallazgo |
| hallazgo | Objeto de hallazgos | El objeto Hallazgos obtenido al ejecutar una prueba, generalmente objeto resultados de run() o analyze() |
| opciones | Objeto LogTestResultsOptions (opcional) | Opciones de configuración del registrador |
Devolución
No se devuelve nada