cypress-axe/dist/index.d.ts

Test accessibility with axe-core in Cypress

import * as axe from 'axe-core';
declare global {
    interface Window {
        axe: typeof axe;
    }
}
declare global {
    namespace Cypress {
        interface Chainable {
            injectAxe: typeof injectAxe;
            configureAxe: typeof configureAxe;
            checkA11y: typeof checkA11y;
        }
    }
}
export interface Options extends axe.RunOptions {
    includedImpacts?: string[];
    interval?: number;
    retries?: number;
}
export interface InjectOptions {
    axeCorePath?: string;
}
export declare const injectAxe: (injectOptions?: InjectOptions | undefined) => void;
export declare const configureAxe: (configurationOptions?: {}) => void;
declare const checkA11y: (context?: string | Node | axe.ContextObject | undefined, options?: Options | undefined, violationCallback?: ((violations: axe.Result[]) => void) | undefined, skipFailures?: boolean) => void;
export {};