Type Alias CompareOptions

The options type for comparePdfToSnapshot.

type CompareOptions = {
    failOnMissingSnapshot?: boolean;
    maskRegions?: MaskRegions;
    pdf2PngOptions?: PdfToPngOptions;
    tolerance?: number;
}

Properties

failOnMissingSnapshot?: boolean

Whether a missing snapshot should cause the comparison to fail.

false

maskRegions?: MaskRegions

Defines a function for masking predefined regions per page, useful for parts of the PDF that change between tests.

pdf2PngOptions?: PdfToPngOptions

Configuration options for converting a PDF to PNG format.

tolerance?: number

Number value for error tolerance in the range [0, 1].