Referencia de la API de Axe DevTools Node Reporter
Referencia de API para el paquete @axe-devtools/reporter
Este documento describe los métodos proporcionados por la clase AxeDevToolsReporter.
La clase AxeDevToolsReporter extiende la clase AxeDevToolsLogger (del paquete @axe-devtools/logger), por lo que puedes crear una instancia de AxeDevToolsReporter y llamar a los métodos ofrecidos por la clase AxeDevToolsLogger. Consulta la Referencia de Axe DevTools Logger para más información sobre los métodos proporcionados por la clase AxeDevToolsLogger.
Constructor
constructor(reportName: string, directory?: string)Ejemplo de uso:
const axeReporter = new AxeDevToolsReporter("AxeDevTools-Results", "./test-results/");Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| nombreDelInforme | cadena | El título del informe. El valor de nombreDelInforme se convertirá en el primer segmento del nombre del archivo de resultados JSON. |
| directorio | cadena (opcional) | Directorio donde se escribirá el informe. Los directorios se crearán recursivamente si no existen. |
Métodos
Cada uno de estos métodos crea el informe especificado a partir del archivo JSON de resultados que se produce mediante el método logTestResult.
| Nombre | Descripción |
|---|---|
| buildCSV | Crea un informe CSV |
| buildEARL | Crea un informe W3C EARL JSON-LD |
| buildHTML | Crea un informe HTML |
| buildJUnitXML | Crea un informe XML |
buildCSV
Crea un archivo CSV a partir del archivo JSON de resultados creado por el método logTestResult.
buildCSV(directory: string, userAgent?: string, filterOpts?: string[]): Promise<void>;Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| directorio | cadena | El directorio para crear el archivo de salida .csv. Todos los directorios se crearán recursivamente si aún no existen. |
| userAgent | cadena (opcional) | Solo aparecerán en el archivo .csv los resultados con el agente de usuario especificado |
| filterOpts | array de cadenas (opcional) | Una matriz de opciones de filtro para seleccionar resultados. |
Devoluciones
Promise<void>buildEARL
Crea un archivo JSON-LD W3C EARL (Evaluation and Report Language) llamado axe-devtools-results.earl.json en el directorio especificado.
La salida EARL no admite resultados de Axe DevTools Mobile. Si hay resultados móviles presentes, buildEARL lanzará un error antes de escribir cualquier archivo.
buildEARL(directory: string, userAgent?: string): Promise<void>;Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| directorio | cadena | El directorio para crear el archivo de salida .earl.json. Todos los directorios se crearán de forma recursiva si no existen. |
| userAgent | cadena (opcional) | Solo aparecerán en el informe EARL los resultados con el agente de usuario especificado |
Devoluciones
Promise<void>buildHTML
Crea un archivo HTML en el directorio especificado a partir del archivo JSON de resultados de accesibilidad.
buildHTML(directory: string, userAgent?: string): Promise<void>;Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| directorio | cadena | El directorio para crear el archivo de salida .html. Todos los directorios se crearán recursivamente si aún no existen. |
| userAgent | cadena (opcional) | Solo aparecerán en el archivo de informe .html los resultados con el agente de usuario especificado |
Devoluciones
Promise<void>buildJUnitXML
Crea un archivo XML de JUnit en el directorio especificado a partir de los resultados de accesibilidad JSON.
buildJUnitXML(directory: string, userAgent?: string): Promise<void>;Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
| directorio | cadena | El directorio para crear el archivo .xml de salida. Todos los directorios se crearán recursivamente si no existen. |
| userAgent | cadena (opcional) | Solo los resultados con el agente de usuario especificado aparecerán en el archivo de informe .xml |
Devoluciones
Promise<void>