Axe DevTools Node Reporter API リファレンス

このドキュメントは、AxeDevToolsReporterクラスが提供するメソッドについて説明します。

AxeDevToolsReporterクラスは@axe-devtools/loggerパッケージのAxeDevToolsLoggerクラスを拡張しており、AxeDevToolsReporterのインスタンスを作成し、AxeDevToolsLoggerクラスが提供するメソッドを呼び出すことができます。Axe DevTools Logger リファレンスを参照して、AxeDevToolsLoggerクラスが提供するメソッドに関する詳細情報をご覧ください。

コンストラクター

constructor(reportName: string, directory?: string)

使用例:

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

パラメータ

メソッド

これらのメソッドのそれぞれは、logTestResultメソッドによって生成された結果JSONファイルから指定されたレポートを作成します。

buildCSV

logTestResultメソッドによって作成された結果JSONファイルからCSVファイルを作成します。

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

パラメータ

返り値

Promise<void>

buildEARL

指定されたディレクトリにaxe-devtools-results.earl.jsonという名前のW3C EARL (Evaluation and Report Language) JSON-LDファイルを作成します。

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

パラメータ

返り値

Promise<void>

buildHTML

指定されたディレクトリに、アクセシビリティ結果 JSON ファイルから HTML ファイルを作成します。

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

パラメータ

返り値

Promise<void>

buildJUnitXML

指定されたディレクトリに、JSON のアクセシビリティ結果から JUnit XML ファイルを作成します。

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

パラメータ

返り値

Promise<void>