@sa11y/wdio/dist/wdio.d.ts

Accessibility testing API for WebdriverIO

/// <reference types="webdriverio/async" />
import { AxeResults, axeVersion, WdioOptions } from '@sa11y/common';
/**
 * Return version of axe injected into browser
 */
export declare function getAxeVersion(driver: WebdriverIO.Browser): Promise<typeof axeVersion>;
/**
 * Load axe source into browser if it is not already loaded and return version of axe.
 * Since axe min js is large (400+kb), keep polling until given timeout in milliseconds.
 */
export declare function loadAxe(driver: WebdriverIO.Browser, timeout?: number, pollTime?: number): Promise<void>;
/**
 * Load and run axe in given WDIO instance and return the accessibility violations found.
 */
export declare function runAxe(options?: Partial<WdioOptions>): Promise<AxeResults>;
/**
 * Verify that the currently loaded page in the browser is accessible.
 * Throw an error with the accessibility issues found if it is not accessible.
 * Asynchronous version of {@link assertAccessibleSync}
 */
export declare function assertAccessible(opts?: Partial<WdioOptions>): Promise<void>;
/**
 * Verify that the currently loaded page in the browser is accessible.
 * Throw an error with the accessibility issues found if it is not accessible.
 * Synchronous version of {@link assertAccessible}
 * @deprecated Please update to using async method.
 */
export declare function assertAccessibleSync(opts?: Partial<WdioOptions>): void;
//# sourceMappingURL=wdio.d.ts.map