Referencia de la API de axe DevTools Node Reporter

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Referencia de API para el paquete @axe-devtools/reporter

Not for use with personal data

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 puede crear una instancia de AxeDevToolsReporter y llamar a los métodos ofrecidos por la clase AxeDevToolsLogger . Consulte la Referencia de axe DevTools Logger para obtener 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
reportName cadena El título del informe. El valor reportName se convertirá en el primer segmento del nombre del archivo de resultados JSON.
directorio Cadena (opcional) Directorio donde se redactará el informe. Los directorios se crearán recursivamente si aún no existen.

Métodos

Cada uno de estos métodos crea el informe especificado a partir del archivo JSON de resultados producido por el método logTestResult .

Nombre Descripción
buildCSV Crear un informe CSV
buildHTML Crear un informe HTML
buildJUnitXML Crear un informe XML

crearCSV

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 .csv de salida. Todos los directorios se crearán recursivamente si aún no existen.
Agente de usuario Cadena (opcional) Solo los resultados con el agente de usuario especificado aparecerán en el archivo .csv
Opciones de filtro Arreglo de cadenas (opcional) Un arreglo de opciones de filtro para seleccionar resultados.

Devuelve

Promise<void>

crearHTML

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 .html de salida. Todos los directorios se crearán recursivamente si aún no existen.
Agente de usuario Cadena (opcional) Solo los resultados con el agente de usuario especificado aparecerán en el archivo de informe .html

Devuelve

Promise<void>

buildJUnitXML

Crea un archivo XML 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 aún no existen.
Agente de usuario Cadena (opcional) Sólo los resultados con el agente de usuario especificado aparecerán en el archivo de informe .xml

Devuelve

Promise<void>

Is this page helpful?

Help us improve this page

Still need help?