Visual regression testing library for PDFs in JavaScript/TypeScript without binary and OS dependencies.
npm install -D pdf-visual-compare
const result = await comparePdf('./pdf1.pdf', './pdf2.pdf');
// If you want to configure the comparing process, use the following options
const result = await comparePdf('./pdf1.pdf', './pdf2.pdf', {
diffsOutputFolder: 'diffs', // Folder to write output PNG files with differences
pdfToPngConvertOptions: {
viewportScale: 2.0, // The desired scale of PNG viewport. Default value is 2.0.
disableFontFace: false, // When `false`, fonts will be rendered using a built-in font renderer that constructs the glyphs with primitive path commands. Default value is true.
useSystemFonts: false, // When `true`, fonts that aren't embedded in the PDF document will fallback to a system font. Default value is false.
pdfFilePassword: 'pa$$word', // Password for encrypted PDF.
outputFolder: 'output/folder', // Folder to write output PNG files. If not specified, PNG output will be available only as a Buffer content, without saving to a file.
outputFileMask: 'buffer', // Output filename mask. Default value is 'buffer'.
pagesToProcess: [1, 3, 11], // Subset of pages to convert (first page = 1), other pages will be skipped if specified.
strictPagesToProcess: false, // When `true`, will throw an error if specified page number in pagesToProcess is invalid, otherwise will skip invalid page. Default value is false.
verbosityLevel: 0 // Verbosity level. ERRORS: 0, WARNINGS: 1, INFOS: 5. Default value is 0.
},
excludedAreas: [], // Areas list to exclude from comparing for each PDF page. Empty array by default.
compareThreshold: 0.1 // Comparing threshold, ranges from 0 to 1. Smaller values make the comparison more sensitive. 0.1 by default.
});
If you want to support my work, you can buy me a coffee.