Axe DevTools Node Reporter API リファレンス

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

AxeDevToolsReporter クラスは AxeDevToolsLogger クラス（@axe-devtools/logger パッケージから）を継承しているため、AxeDevToolsReporter のインスタンスを作成し AxeDevToolsLogger クラスが提供するメソッドを呼び出すことができます。Axe DevTools Logger リファレンス を参照すると、AxeDevToolsLogger クラスが提供するメソッドの詳細を確認できます。

このページのメソッドシグネチャは、パッケージにバンドルされた型宣言と一致するようにTypeScriptの表記で書かれています。使用例はJavaScriptで書かれており、TypeScriptでも変更なしでコンパイルされます。完全なファイルのJavaScriptとTypeScriptの並列バージョンについては、レポートの生成をご覧ください。

コンストラクター

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, renderOptions?: RenderOptions): Promise<void>;

パラメータ

返り値

Promise<void>

RenderOptions

レポートが静的マークアップとして事前レンダリングされる方法を制御するために buildHTML に渡されます。すべてのオプションはオプションであり、オプションが設定されていない場合、それぞれに適用される環境変数があります。レンダラーは呼び出しごとに1度だけ選択されるため、これらのオプションはその呼び出しで作成されたすべてのレポートに適用されます。

自動検出により、各レポートに対してブラウザプロセスが開始されます。大規模なバッチ実行時、またはリポーターが発見したブラウザの開始が望ましくないビルドマシン上で、autoDetectBrowser を false に設定し、browserPath を提供するか jsdom をインストールしてください。

buildJUnitXML

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

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

パラメータ

返り値

Promise<void>