@lwc/jest-preset/types/index.d.ts

Jest preset configuration and stubs to help test LWC

/* eslint-disable */
// Inspired by:
// - https://unpkg.com/browse/expect@29.6.2/build/index.d.ts
// - https://unpkg.com/browse/@testing-library/jest-dom@6.0.1/types/matchers.d.ts
import { type expect } from '@jest/globals';

// These types come from @types/jest
// https://github.com/DefinitelyTyped/DefinitelyTyped/blob/bd28a85/types/jest/index.d.ts#L1154-L1161
interface Constructable {
    new (...args: any[]): any;
}

interface LwcJestMatchers<E, R> {
    /**
     * @description
     * Assert that appending a custom element to the DOM causes an error to be thrown from that element's `connectedCallback`.
     * @example
     * expect(() => {
     *     document.body.appendChild(element);
     * }).toThrowInConnectedCallback('expected error message');
     * @see
     * [@lwc/jest-preset docs](https://github.com/salesforce/lwc-test/blob/master/packages/%40lwc/jest-preset/README.md#custom-matchers)
     */
    // These types come from @types/jest, see above
    toThrowInConnectedCallback(expected?: string | Constructable | RegExp | Error): R;

    /**
     * @description
     * Assert that appending a custom element to the DOM causes an error to be thrown from that element's `connectedCallback`.
     *
     * Equivalent to `toThrowInConnectedCallback`.
     * @example
     * expect(() => {
     *     document.body.appendChild(element);
     * }).toThrowErrorInConnectedCallback('expected error message');
     * @see
     * [@lwc/jest-preset docs](https://github.com/salesforce/lwc-test/blob/master/packages/%40lwc/jest-preset/README.md#custom-matchers)
     */
    // These types come from @types/jest, see above
    toThrowErrorInConnectedCallback(expected?: string | Constructable | RegExp | Error): R;
}

declare global {
    namespace jest {
        interface Matchers<R = void, T = {}>
            extends LwcJestMatchers<ReturnType<typeof expect.stringContaining>, R> {}
    }
}

declare module '@jest/expect' {
    export interface Matchers<R extends void | Promise<void>>
        extends LwcJestMatchers<ReturnType<typeof expect.stringContaining>, R> {}
}

export {};