Referencia de la API del registrador de nodos de axe DevTools
Referencia de 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 puedes usar para escribir un archivo de resultados JSON en el directorio especificado. Puede utilizar la API de informes para generar informes en varios formatos diferentes a partir de este archivo de resultados.
constructor(reportName: string, directory?: string)Ejemplo de uso:
let logger = new AxeDevToolsLogger("Report Name", "directory-name");Debido a que la clase AxeDevToolsReporter hereda de esta clase, normalmente se invocan 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 logger escribirá el archivo de resultados JSON |
Métodos
| Nombre | Descripción |
|---|---|
| getTestResults | Devuelve un array de resultados de pruebas. |
| logTestResult | Registrar resultados de pruebas. |
getTestResults
Devuelve una matriz de resultados de pruebas 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. Sólo se escribirán en el disco los resultados en los que coincida el agente de usuario . |
Retornos
Un arreglo de AxeDevToolsResults
logTestResult
Registra el resultado de accesibilidad actual en el disco. Consulte Ejemplos de código de informes para ver 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 resultado. |
| resultado | Objeto de los Resultados | El objeto Resultados obtenido al ejecutar una prueba, generalmente el objeto Resultados de run() o analyze() |
| Opciones | Objeto LogTestResultsOptions (opcional) | Opciones de configuración del Logger |
De vuelta
No se devuelve nada