ššø Converts PDFs to images in nodejs
npm install pdf-to-img
!npm bundle size
ššø Converts PDFs to images in nodejs.
Useful for unit tests of PDFs
Supports nodejs v20+, and comes with a CLI.
``sh`
npm install -S pdf-to-img
NodeJS (using ESM Modules):
`js
import { promises as fs } from "node:fs";
import { pdf } from "pdf-to-img";
async function main() {
let counter = 1;
const document = await pdf("example.pdf", { scale: 3 });
for await (const image of document) {
await fs.writeFile(page${counter}.png, image);
counter++;
}
// you can also read a specific page number:
const page12buffer = await document.getPage(12)
}
main();
`
If your app does not support ESM modules, you can use v3 (see the warning above), or just change the import:
`diff
+ const { promises: fs } = require("node:fs");
- import { promises as fs } from "node:fs";
- import { pdf } from "pdf-to-img";
async function main() {
+ const { pdf } = await import("pdf-to-img");
let counter = 1;
const document = await pdf("example.pdf", { scale: 3 });
for await (const image of document) {
await fs.writeFile(page${counter}.png, image);`
counter++;
}
}
main();
Using jest (or vitest) with jest-image-snapshot:
`js
import { pdf } from "pdf-to-img";
it("generates a PDF", async () => {
for await (const page of await pdf("example.pdf")) {
expect(page).toMatchImageSnapshot();
}
});
// or if you want access to more details:
it("generates a PDF with 2 pages", async () => {
const doc = await pdf("example.pdf");
expect(doc.length).toBe(2);
expect(doc.metadata).toEqual({ ... });
for await (const page of doc) {
expect(page).toMatchImageSnapshot();
}
});
`
The pdf function accepts either a path to the file on disk, or a data URL (e.g. data:application/pdf;base64,...)
You can supply a second argument which is an object of options:
`js
const doc = await pdf("example.pdf", {
password: "...", // if the PDF is encrypted
scale: 2.0, // use this for PDFs with high resolution images if the generated image is low quality
});
`
`sh
npm i -g pdf-to-img@latest