Referência da API 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

Referência da API para o pacote @axe-devtools/reporter

Not for use with personal data

Este documento descreve os métodos fornecidos pela classe AxeDevToolsReporter.

A classe AxeDevToolsReporter estende a classe AxeDevToolsLogger (do pacote @axe-devtools/logger), permitindo que você crie uma instância de AxeDevToolsReporter e chame métodos oferecidos pela classe AxeDevToolsLogger. Consulte a Referência do Axe DevTools Logger para mais informações sobre os métodos fornecidos pela classe AxeDevToolsLogger.

Construtor

constructor(reportName: string, directory?: string)

Exemplo de uso:

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

Parâmetros

Nome Tipo Descrição
reportName string O título do relatório. O valor reportName se tornará o primeiro segmento do nome do arquivo dos resultados JSON.
diretório string (opcional) Diretório onde o relatório será gravado. Diretórios serão criados recursivamente se ainda não existirem.

Métodos

Cada um desses métodos cria o relatório especificado a partir do arquivo JSON de resultados que é produzido pelo método logTestResult.

Nome Descrição
buildCSV Cria um relatório em CSV
buildEARL Cria um relatório W3C EARL JSON-LD
buildHTML Cria um relatório em HTML
buildJUnitXML Cria um relatório em XML

buildCSV

Cria um arquivo CSV a partir do arquivo JSON de resultados criado pelo método logTestResult.

buildCSV(directory: string, userAgent?: string, filterOpts?: string[]): Promise<void>;

Parâmetros

Nome Tipo Descrição
diretório string O diretório para criar o arquivo .csv de saída. Todos os diretórios serão criados recursivamente se não existirem.
userAgent string (opcional) Somente os resultados com o user agent especificado aparecerão no arquivo .csv
filterOpts array de strings (opcional) Um array de opções de filtro para selecionar resultados.

Retorna

Promise<void>

buildEARL

Cria um arquivo JSON-LD W3C EARL (Evaluation and Report Language) chamado axe-devtools-results.earl.json no diretório especificado.

note

A saída EARL não suporta resultados do Axe DevTools Mobile. Se houver resultados móveis presentes, buildEARL lança um erro antes de escrever qualquer arquivo.

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

Parâmetros

Nome Tipo Descrição
diretório string O diretório para criar o arquivo de saída .earl.json. Todos os diretórios serão criados recursivamente se ainda não existirem.
userAgent string (opcional) Somente os resultados com o user agent especificado aparecerão no relatório EARL

Retorna

Promise<void>

buildHTML

Cria um arquivo HTML no diretório especificado a partir do arquivo JSON de resultados de acessibilidade.

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

Parâmetros

Nome Tipo Descrição
diretório string O diretório para criar o arquivo .html de saída. Todos os diretórios serão criados recursivamente se não existirem.
userAgent string (opcional) Somente os resultados com o user agent especificado aparecerão no arquivo de relatório .html

Retorna

Promise<void>

buildJUnitXML

Cria um arquivo XML JUnit no diretório especificado a partir dos resultados de acessibilidade JSON.

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

Parâmetros

Nome Tipo Descrição
diretório string O diretório para criar o arquivo .xml de saída. Todos os diretórios serão criados recursivamente se ainda não existirem.
userAgent string (opcional) Somente os resultados com o agente de usuário especificado aparecerão no arquivo de relatório .xml

Retorna

Promise<void>

Is this page helpful?

Help us improve this page

Still need help?