axe-playwright/dist/types.d.ts

Custom Playwright commands to inject axe-core and test for a11y

import { Result, Check, ImpactValue, Locale, Rule, RunOptions } from 'axe-core';
export interface NodeViolation {
    target: string;
    html: string;
    violations: string;
}
export interface Aggregate {
    [key: string]: {
        target: string;
        html: string;
        violations: number[];
    };
}
export default interface Reporter {
    report(violations: Result[]): Promise<void>;
}
export interface axeOptionsConfig {
    axeOptions?: RunOptions;
}
export interface ConfigOptions {
    branding?: {
        brand?: string;
        application?: string;
    };
    reporter?: 'v1' | 'v2' | 'no-passes';
    checks?: Check[];
    rules?: Rule[];
    locale?: Locale;
    axeVersion?: string;
}
/**
 * Implement this interface to be able to specific custom reporting behaviour for checkA11y method.
 * @see checkA11y
 */
export default interface Reporter {
    report(violations: Result[]): Promise<void>;
}
export type AxeOptions = {
    includedImpacts?: ImpactValue[];
    detailedReport?: boolean;
    detailedReportOptions?: {
        html?: boolean;
    };
    verbose?: boolean;
} & axeOptionsConfig;