@types/jest-axe
    TypeScript icon, indicating that this package has built-in type declarations

    3.5.3 • Public • Published

    Installation

    npm install --save @types/jest-axe

    Summary

    This package contains type definitions for jest-axe (https://github.com/nickcolley/jest-axe).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest-axe.

    index.d.ts

    // Type definitions for jest-axe 3.5
    // Project: https://github.com/nickcolley/jest-axe
    // Definitions by: erbridge <https://github.com/erbridge>
    // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
    // TypeScript Version: 3.8
    
    /// <reference types="jest" />
    
    import { AxeResults, Result, RunOptions, Spec } from 'axe-core';
    
    export interface JestAxeConfigureOptions extends RunOptions {
        globalOptions?: Spec | undefined;
    }
    
    /**
     * Version of the aXe verifier with defaults set.
     *
     * @remarks You can still pass additional options to this new instance;
     *          they will be merged with the defaults.
     */
    export const axe: JestAxe;
    
    /**
     * Runs aXe on HTML.
     *
     * @param html   Raw HTML string to verify with aXe.
     * @param options   Options to run aXe.
     * @returns Promise for the results of running aXe.
     */
    export type JestAxe = (html: Element | string, options?: RunOptions) => Promise<AxeResults>;
    
    /**
     * Creates a new aXe verifier function.
     *
     * @param options   Options to run aXe.
     * @returns New aXe verifier function.
     */
    export function configureAxe(options?: JestAxeConfigureOptions): JestAxe;
    
    /**
     * Results from asserting whether aXe verification passed.
     */
    export interface AssertionsResult {
        /**
         * Actual checked aXe verification results.
         */
        actual: Result[];
    
        /**
         * @returns Message from the Jest assertion.
         */
        message(): string;
    
        /**
         * Whether the assertion passed.
         */
        pass: boolean;
    }
    
    /**
     * Asserts an aXe-verified result has no violations.
     *
     * @param results   aXe verification result, if not running via expect().
     * @returns Jest expectations for the aXe result.
     */
    export type IToHaveNoViolations = (results?: Partial<AxeResults>) => AssertionsResult;
    
    export const toHaveNoViolations: {
        toHaveNoViolations: IToHaveNoViolations;
    };
    
    declare global {
        namespace jest {
            interface Matchers<R, T> {
                toHaveNoViolations(): R;
            }
        }
    
        // axe-core depends on a global Node
        interface Node {}
    }

    Additional Details

    Credits

    These definitions were written by erbridge.

    Keywords

    none

    Install

    npm i @types/jest-axe

    DownloadsWeekly Downloads

    137,287

    Version

    3.5.3

    License

    MIT

    Unpacked Size

    6.79 kB

    Total Files

    4

    Last publish

    Collaborators

    • types