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), para que você possa criar uma instância de AxeDevToolsReporter e chamar os métodos oferecidos pela classe AxeDevToolsLogger. Consulte o Referência do Axe DevTools Logger para mais informações sobre os métodos fornecidos pela classe AxeDevToolsLogger.

As assinaturas dos métodos nesta página são escritas na notação TypeScript, correspondendo às declarações de tipo incluídas no pacote. Os exemplos de uso são em JavaScript e compilam sem alterações em TypeScript. Para versões lado a lado de JavaScript e TypeScript de um arquivo completo, veja Gerar Relatórios.

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 de resultados JSON.
directory 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
directory string O diretório para criar o arquivo de saída .csv. Todos os diretórios serão criados recursivamente se ainda não existirem.
userAgent string (opcional) Somente resultados com o agente de usuário especificado aparecerão no arquivo .csv
filterOpts string[] (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
directory 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, renderOptions?: RenderOptions): Promise<void>;

Parâmetros

Nome Tipo Descrição
directory string O diretório para criar o arquivo de saída .html. Todos os diretórios serão criados recursivamente se ainda não existirem.
userAgent string (opcional) Somente resultados com o agente de usuário especificado aparecerão no arquivo de relatório .html
renderOptions RenderOptions (opcional) Controla como o relatório é pré-renderizado em uma marcação estática. Veja Pré-renderizando relatórios HTML.

Retorna

Promise<void>

Opções de Renderização

Passado para buildHTML para controlar como o relatório é pré-renderizado em uma marcação estática. Cada opção é opcional, e cada uma tem uma variável de ambiente que se aplica quando a opção não está definida. O renderizador é selecionado uma vez por chamada, então essas opções se aplicam a cada relatório que essa chamada gera.

Nome Tipo Padrão Descrição
browserPath string nenhum Caminho para um executável de navegador usado para pré-renderizar o relatório. Variável de ambiente: AXE_DEVTOOLS_REPORTER_BROWSER_PATH.
autoDetectBrowser boolean true Se deve procurar por um navegador baseado em Chromium já instalado nesta máquina quando nenhum caminho de navegador é fornecido e jsdom não está instalado. Defina-o como false para pular a pré-renderização em vez de executar um navegador que o relatador descobriu por conta própria. Variável de ambiente: AXE_DEVTOOLS_REPORTER_BROWSER_AUTO_DETECT.
noSandbox boolean false Desativa o sandbox do navegador. Deixe o sandbox ativado, a menos que você esteja em um ambiente confiável e restrito que não possa suportá-lo. Variável de ambiente: AXE_DEVTOOLS_REPORTER_BROWSER_NO_SANDBOX.
maxBufferBytes number 67108864 (64 MB) Quantidade máxima de saída renderizada a ser armazenada no buffer do navegador. Aumente isso se um relatório grande não for renderizado com erro de estouro de buffer.
virtualTimeBudgetMs number 5000 Quanto tempo o navegador tem para renderizar o relatório antes que seu conteúdo seja capturado. Aumente isso se um relatório grande for escrito sem seu conteúdo.
renderTimeoutMs number 30000 Limite de tempo para a renderização do navegador. Um navegador que nunca sai é interrompido e a renderização falha.
distDirectory string a cópia incluída com o pacote Diretório contendo os ativos do cliente do relatório. Defina isso apenas quando os arquivos do pacote não estiverem onde a própria resolução de módulo espera, como quando sua aplicação é agrupada em um único executável.
note

O navegador é usado apenas quando o caminho resolve para um arquivo que existe. Se você definir browserPath (ou AXE_DEVTOOLS_REPORTER_BROWSER_PATH) para um caminho que não existe, o relatador passa para o próximo método de renderização em vez de relatar um erro, então verifique o caminho se você precisar que uma má configuração se torne aparente.

A autodetecção inicia um processo de navegador para cada relatório. Em uma execução em lote grande, ou em uma máquina de construção onde iniciar um navegador que o relatador descobriu por conta própria é indesejável, defina autoDetectBrowser para false e forneça browserPath ou instale jsdom.

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
directory string O diretório para criar o arquivo de saída .xml. Todos os diretórios serão criados recursivamente se ainda não existirem.
userAgent string (opcional) Somente 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?