Referência da API do Axe DevTools Node Logger

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/logger

Not for use with personal data

Este documento descreve os métodos implementados pela classe AxeDevToolsLogger no pacote @axe-devtools/logger.

Construtor

Cria um logger do Axe DevTools que você pode usar para escrever um arquivo de resultados JSON no diretório especificado. Você pode usar o API de Relatório para gerar relatórios em vários formatos diferentes a partir deste arquivo de resultados.

constructor(reportName: string, directory?: string)

Exemplo de uso:

let logger = new AxeDevToolsLogger("Report Name", "directory-name");
note

Como a classe AxeDevToolsReporter herda desta classe, você normalmente invoca métodos na classe AxeDevToolsLogger através da sua instância de AxeDevToolsReporter.

Parâmetros

Nome Tipo Descrição
reportName string O nome do relatório, que será a primeira parte do nome do arquivo de resultados de saída.
diretório string (opcional) O diretório onde a API do logger irá escrever o arquivo de resultados JSON

Métodos

Nome Descrição
getTestResults Retorna um array de resultados de teste.
logTestResult Registrar resultados de teste.

getTestResults

Retorna um array de resultados de teste do Axe DevTools. Os resultados podem ser filtrados por userAgent.

public getTestResults(userAgent?: string): AxeDevToolsResults[]

Parâmetros

Nome Tipo Descrição
userAgent string (opcional) Especifica o userAgent para filtrar os resultados. Somente resultados onde o userAgent coincidir serão escritos no disco.

Retornos

Um array de AxeDevToolsResults

logTestResult

Registra o resultado atual de acessibilidade no disco. Veja Exemplos de Código do Relatório para exemplos de código.

public logTestResult(
    id: string,
    finding: Findings,
    options?: LogTestResultOptions
  ): void

Parâmetros

Nome Tipo Descrição
id string Um identificador fornecido pelo usuário para a constatação
constatação Objeto de Constatações O objeto Constatações obtido a partir da execução de um teste, geralmente objeto resultados de run() ou analyze()
opções Objeto LogTestResultsOptions (opcional) Opções de configuração do Logger

Retorno

Nada é retornado

Is this page helpful?

Help us improve this page

Still need help?