html-validate/dist/types/jest.d.ts

Offline HTML5 validator and linter

export { }



import { type ConfigData } from "./index"
import { type Message } from "./index"
declare global {
    namespace jest {
        interface Matchers<R, T = {}> {
            toBeValid(): R;
            toBeInvalid(): R;
            toHaveError(error: Partial<Message>): R;
            toHaveError(ruleId: string, message: string, context?: any): R;
            toHaveErrors(errors: Array<[string, string] | Record<string, unknown>>): R;
            /**
             * Validate string or HTMLElement.
             *
             * Test passes if result is valid.
             *
             * @param config - Optional HTML-Validate configuration object.
             * @param filename - Optional filename used when matching transformer and
             * loading configuration.
             */
            toHTMLValidate(filename?: string): R;
            toHTMLValidate(config: ConfigData, filename?: string): R;
            toHTMLValidate(error: Partial<Message>, filename?: string): R;
            toHTMLValidate(error: Partial<Message>, config: ConfigData, filename?: string): R;
            /**
             * Writes out the given [[Report]] using codeframe formatter and compares
             * with snapshot.
             */
            toMatchCodeframe(snapshot?: string): R;
            /**
             * Writes out the given [[Report]] using codeframe formatter and compares
             * with inline snapshot.
             */
            toMatchInlineCodeframe(snapshot?: string): R;
        }
    }
}