pdf-visual-diff/lib/compare-images.d.ts

Visual Regression Testing for PDFs in JavaScript

import { JimpInstance } from 'jimp';
export declare const mkDiffPath: (path: string) => string;
/** The options type for {@link compareImages}. */
export type CompareImagesOpts = {
    tolerance?: number;
};
type CompareOK = {
    equal: true;
};
type CompareKO = {
    equal: false;
    diffs: ReadonlyArray<{
        page: number;
        diff: JimpInstance;
    }>;
};
type CompareImagesResult = CompareOK | CompareKO;
export declare const compareImages: (expectedImagePath: string, images: ReadonlyArray<JimpInstance>, options?: CompareImagesOpts) => Promise<CompareImagesResult>;
export {};