Referencia de la API de Axe DevTools Node 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 el Referencia de Axe DevTools Logger para más información sobre los métodos proporcionados por la clase AxeDevToolsLogger.

Las firmas de métodos en esta página están escritas en notación TypeScript, coincidiendo con las declaraciones de tipo incluidas en el paquete. Los ejemplos de uso son en JavaScript y se compilan sin cambios en TypeScript. Para ver versiones de JavaScript y TypeScript lado a lado de un archivo completo, vea Generación de informes.

Constructor

constructor(reportName: string, directory?: string)

Ejemplo de uso:

const axeReporter = new AxeDevToolsReporter("AxeDevTools-Results", "./test-results/");

Parámetros

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.

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

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.

buildEARL(directory: string, userAgent?: string): Promise<void>;

Parámetros

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, renderOptions?: RenderOptions): Promise<void>;

Parámetros

Devoluciones

Promise<void>

OpcionesDeRenderizado

Se pasa a buildHTML para controlar cómo se pre-renderiza el informe en un marcado estático. Cada opción es opcional, y cada una tiene una variable de entorno que se aplica cuando la opción no está configurada. El renderizador se selecciona una vez por llamada, por lo que estas opciones se aplican a cada informe que construye esa llamada.

La detección automática inicia un proceso de navegador para cada informe. En una ejecución de lote grande, o en una máquina de construcción donde iniciar un navegador que el reportero descubrió por sí mismo no es deseado, configura autoDetectBrowser a false y proporciona browserPath o instala jsdom.

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

Devoluciones

Promise<void>