# pdf-to-img

> 📃📸 Converts PDFs to images in nodejs

Latest version **7.0.0** (published 2026-09-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install pdf-to-img
pnpm add pdf-to-img
yarn add pdf-to-img
bun add pdf-to-img
```

Provides the command `pdf2img`.

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 7.0.0 |
| Published | 2026-09-01 |
| First published | 2021-02-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=22.13.0 \|\| >=24 |
| Dependencies | 1 |
| Unpacked size | 16.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 142 |
| Author | Kyle Hensel |
| Maintainers | kyle.h |
| Keywords | pdf, pdfjs, pdf-to-img, pdf-to-png, vitest, jest |

## Links

- npm: https://www.npmjs.com/package/pdf-to-img
- Repository: https://github.com/k-yle/pdf-to-img
- Homepage: https://github.com/k-yle/pdf-to-img#readme
- Issues: https://github.com/k-yle/pdf-to-img/issues
- npm.io page: https://npm.io/package/pdf-to-img

## Dependencies (1)

- [pdfjs-dist](https://npm.io/package/pdfjs-dist.md) ~6.2.108

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 7.0.0 (latest) — 2026-09-01
- 6.3.0 — 2026-08-25
- 6.2.0 — 2026-06-12
- 6.1.0 — 2026-05-13
- 6.0.0 — 2026-04-10
- 5.0.0 — 2025-09-08
- 4.5.0 — 2025-06-05
- 4.4.0 — 2025-02-16
- 4.3.0 — 2024-11-13
- 4.2.0 — 2024-11-02
- 4.1.1 — 2024-09-17
- 4.1.0 — 2024-08-07
- 4.0.0 — 2024-06-08
- 3.0.0 — 2024-05-25
- 2.1.2 — 2023-10-04
- … 10 more at https://npm.io/package/pdf-to-img/versions

## README

# pdf-to-img

[![Build Status](https://github.com/k-yle/pdf-to-img/workflows/Build%20and%20Test/badge.svg)](https://github.com/k-yle/pdf-to-img/actions)
[![Coverage Status](https://coveralls.io/repos/github/k-yle/pdf-to-img/badge.svg?branch=main&t=LQmPNl)](https://coveralls.io/github/k-yle/pdf-to-img?branch=main)
[![npm version](https://badge.fury.io/js/pdf-to-img.svg)](https://badge.fury.io/js/pdf-to-img)
[![npm](https://img.shields.io/npm/dt/pdf-to-img.svg)](https://www.npmjs.com/package/pdf-to-img)
![npm bundle size](https://img.shields.io/bundlephobia/minzip/pdf-to-img)

📃📸 Converts PDFs to images in nodejs.

Useful for unit tests of PDFs

Supports nodejs v22.13+, and comes with a CLI.

## Install

```sh
npm install -S pdf-to-img
```

## Example

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](https://npm.im/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,...`)

### Options

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

  format: "jpg", // use "png" (default), "jpg", or "jpeg"
});
```

### Resource management

Document instances are not automatically freed from memory.
Once you have finished with `doc`, you should call `doc.destroy()`.

Or even better, replace `const` with `await using`.
This is a new JS language feature known as [explicit resource management](https://developer.mozilla.org/docs/Web/JavaScript/Guide/Resource_management), which is available in Node 24 and newer.

```diff
-  const       doc = await pdf("example.pdf");
+  await using doc = await pdf("example.pdf");
   for await (const page of doc) {
```

If you use `await using`, then you do not need to explicitly call `.destroy()`.
Instead, the document will automatically be destroyed at the end of [the block scope](https://developer.mozilla.org/docs/Glossary/Scope).

## CLI

```sh
npm i -g pdf-to-img@latest

# example:
pdf2img inputFile.pdf

# options:
# -s / --scale: set the scale (defaults to 3)
# -p / --password: the password to unlock the PDF
# -o / --output: the output folder, relative to the current working directory.
# -g / --pages: set which pages to convert. eg: 1,4,7 (defaults to all pages)
# -f / --format: output format: png (default), jpg, or jpeg
```

---
_Source: https://npm.io/package/pdf-to-img · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._