@types/cypress-image-snapshot/index.d.ts

TypeScript definitions for cypress-image-snapshot

export interface Options extends
    Partial<
        {
            blackout: string[];
            capture: "runner" | "viewport" | "fullPage";
            clip: { x: number; y: number; width: number; height: number };
            disableTimersAndAnimations: boolean;
            padding: number | [number] | [number, number] | [number, number, number] | [number, number, number, number];
            scale: boolean;
            beforeScreenshot(doc: Document): void;
            afterScreenshot(doc: Document): void;
        } & {
            /**
             * If set to true, the build will not fail when the screenshots to compare have different sizes.
             * @default false
             */
            allowSizeMismatch?: boolean | undefined;
            /**
             * The method by which images are compared.
             * `pixelmatch` does a pixel by pixel comparison, whereas `ssim` does a structural similarity comparison.
             * @default 'pixelmatch'
             */
            comparisonMethod?: "pixelmatch" | "ssim" | undefined;
            /**
             * Custom config passed to 'pixelmatch' or 'ssim'
             */
            customDiffConfig?: {
                readonly threshold?: number | undefined;
                readonly includeAA?: boolean | undefined;
            } | undefined;
            /**
             * Custom snapshots directory.
             * Absolute path of a directory to keep the snapshot in.
             */
            customSnapshotsDir?: string | undefined;
            /**
             * A custom absolute path of a directory to keep this diff in
             */
            customDiffDir?: string | undefined;
            /**
             * A custom name to give this snapshot. If not provided, one is computed automatically. When a function is provided
             * it is called with an object containing testPath, currentTestName, counter and defaultIdentifier as its first
             * argument. The function must return an identifier to use for the snapshot.
             */
            customSnapshotIdentifier?:
                | ((parameters: {
                    testPath: string;
                    currentTestName: string;
                    counter: number;
                    defaultIdentifier: string;
                }) => string)
                | string
                | undefined;
            /**
             * Changes diff image layout direction.
             * @default 'horizontal'
             */
            diffDirection?: "horizontal" | "vertical" | undefined;
            /**
             * Will output base64 string of a diff image to console in case of failed tests (in addition to creating a diff image).
             * This string can be copy-pasted to a browser address string to preview the diff for a failed test.
             * @default false
             */
            dumpDiffToConsole?: boolean | undefined;
            /**
             * Removes coloring from the console output, useful if storing the results to a file.
             * @default false.
             */
            noColors?: boolean | undefined;
            /**
             * Sets the threshold that would trigger a test failure based on the failureThresholdType selected. This is different
             * to the customDiffConfig.threshold above - the customDiffConfig.threshold is the per pixel failure threshold, whereas
             * this is the failure threshold for the entire comparison.
             * @default 0.
             */
            failureThreshold?: number | undefined;
            /**
             * Sets the type of threshold that would trigger a failure.
             * @default 'pixel'.
             */
            failureThresholdType?: "pixel" | "percent" | undefined;
            /**
             * Updates a snapshot even if it passed the threshold against the existing one.
             * @default false.
             */
            updatePassedSnapshot?: boolean | undefined;
            /**
             * Applies Gaussian Blur on compared images, accepts radius in pixels as value. Useful when you have noise after
             * scaling images per different resolutions on your target website, usually setting its value to 1-2 should be
             * enough to solve that problem.
             * @default 0.
             */
            blur?: number | undefined;
            /**
             * Runs the diff in process without spawning a child process.
             * @default false.
             */
            runInProcess?: boolean | undefined;
        }
    >
{}

declare global {
    namespace Cypress {
        interface Chainable {
            matchImageSnapshot(nameOrOptions?: string | Options): void;
            matchImageSnapshot(name: string, options: Options): void;
        }
    }
}