index.d.ts

declare module '@testcafe-community/axe' {
  import { ElementContext, RunOnly, AxeResults, Result, Spec } from 'axe-core';

  interface AxeCheck {
      results: AxeResults;
      error?: any;
  }

  export function runAxe(
      context?: ElementContext,
      options?: {
          runOnly?: RunOnly;
          rules?: Object;
          iframes?: Boolean;
          elementRef?: Boolean;
          selectors?: Boolean;
      }
  ): Promise<AxeCheck>;

  export function configureAxe(spec: Spec): Promise<void>;

  export function axeCheck(
    t: TestController,
    context?: ElementContext,
    options?: {
      runOnly?: RunOnly;
      rules?: Object;
      iframes?: Boolean;
      elementRef?: Boolean;
      selectors?: Boolean;
    }
  ): Promise<AxeCheck>;

  export function createReport(violations: Result[]): string;

  export function checkForViolations(
    t: TestController,
    context?: ElementContext,
    options?: {
      runOnly?: RunOnly;
      rules?: Object;
      iframes?: Boolean;
      elementRef?: Boolean;
      selectors?: Boolean;
    }
  ): never;
}