Type Alias CompareOptions

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

The options type for comparePdfToSnapshot.

Type declaration

  • OptionalfailOnMissingSnapshot?: boolean

    Whether a missing snapshot should cause the comparison to fail.

    false
    
  • OptionalmaskRegions?: MaskRegions

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

  • Optionalpdf2PngOptions?: PdfToPngOptions

    Configuration options for converting a PDF to PNG format.

  • Optionaltolerance?: number

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

    0