node-poppler

node-poppler

Asynchronous node.js wrapper for the Poppler PDF rendering library

Overview

Poppler is a PDF rendering library that also includes a collection of utility binaries, which allows for the manipulation and extraction of data from PDF documents such as converting PDF files to HTML, TXT, or PostScript.

The node-poppler module provides an asynchronous node.js wrapper around said utility binaries for easier use.

Installation

Install using npm:

npm i node-poppler

Linux and macOS/Darwin support

Windows binaries are provided with this repository. For Linux users, you will need to download the poppler-data and poppler-utils binaries separately.

An example of downloading the binaries on a Debian system:

sudo apt-get install poppler-data poppler-utils

For macOS users, you can download the latest versions with Homebrew:

brew install poppler

Example usage

Please refer to the JSDoc comments in the source code or the generated type definitions for information on the available options.

poppler.pdfToCairo

Example of an async await call to poppler.pdfToCairo(), to convert only the first and second page of a PDF file to PNG:

const { Poppler } = require("node-poppler");

const file = "test_document.pdf";
const poppler = new Poppler();
const options = {
	firstPageToConvert: 1,
	lastPageToConvert: 2,
	pngFile: true,
};
const outputFile = `test_document.png`;

const res = await poppler.pdfToCairo(file, outputFile, options);
console.log(res);

Example of an async await call to poppler.pdfToCairo(), to convert only the first of a PDF file to a new PDF file using stdout:

const { writeFile } = require("node:fs/promises");
const { Poppler } = require("node-poppler");

const file = "test_document.pdf";
const poppler = new Poppler();
const options = {
	lastPageToConvert: 1,
	pdfFile: true,
};

const res = await poppler.pdfToCairo(file, undefined, options);
// pdfToCairo writes to stdout using binary encoding if pdfFile or singleFile options are used
await writeFile("new_file.pdf", res, { encoding: "binary" });

poppler.pdfToHtml

Example of calling poppler.pdfToHtml() with a promise chain:

const { Poppler } = require("node-poppler");

const file = "test_document.pdf";
const poppler = new Poppler();
const options = {
	firstPageToConvert: 1,
	lastPageToConvert: 2,
};

poppler
	.pdfToHtml(file, undefined, options)
	.then((res) => {
		console.log(res);
	})
	.catch((err) => {
		console.error(err);
		throw err;
	});

Example of calling poppler.pdfToHtml() with a promise chain, providing a Buffer as an input:

const { readFileSync } = require("node:fs");
const { Poppler } = require("node-poppler");

const file = readFileSync("test_document.pdf");
const poppler = new Poppler();
const options = {
	firstPageToConvert: 1,
	lastPageToConvert: 2,
};

poppler
	.pdfToHtml(file, "tester.html", options)
	.then((res) => {
		console.log(res);
	})
	.catch((err) => {
		console.error(err);
		throw err;
	});

poppler.pdfToText

Example of calling poppler.pdfToText() with a promise chain:

const { Poppler } = require("node-poppler");

const file = "test_document.pdf";
const poppler = new Poppler();
const options = {
	firstPageToConvert: 1,
	lastPageToConvert: 2,
};
const outputFile = "test_document.txt";

poppler
	.pdfToText(file, outputFile, options)
	.then((res) => {
		console.log(res);
	})
	.catch((err) => {
		console.error(err);
		throw err;
	});

Contributing

Contributions are welcome, and any help is greatly appreciated!

See the contributing guide for details on how to get started. Please adhere to this project's Code of Conduct when contributing.

Acknowledgements

• Albert Astals Cid - Poppler developer
• Filipe Fernandes - poppler-feedstock maintainer
• Peter Williams - poppler-feedstock maintainer
• Owen Schwartz - poppler-windows developer
• Uwe Korn - poppler-feedstock maintainer
• Xylar Asay-Davis - poppler-feedstock maintainer

License

node-poppler is licensed under the MIT license.

Changelog

7.2.1 (2024-07-30)

Continuous integration

• cd: sort release note sections alphabetically (c7f8d31)
• ci: add node 22 to test matrix (1739c55)
• ci: audit package signatures and provenance attestations (6d4e25c)
• ci: ignore recommended packages (4fff485)
• ci: run apt-get update for ubuntu tests (35e548a)
• deps: bump coverallsapp/github-action from 2.2.3 to 2.3.0 (#583) (894f7ca)
• deps: bump wagoid/commitlint-github-action from 5 to 6 (#574) (0369669)
• use latest node lts version (dc9d91d)

Dependencies

• deps-dev: bump dev dependencies (e189c9d)
• deps-dev: bump glob from 10.4.5 to 11.0.0 (#587) (9480652)
• deps: bump semver from 7.6.0 to 7.6.3 (b3ccf43)

Documentation

• readme: add parameter for pdfToText function (#573) (ba77074)
• readme: update sudo commands (8866344)

Miscellaneous

• .husky/commit-msg: remove npx usage (65cad62)
• package: change author email (b221d6d)
• package: use shorter semver syntax (e074e99)
• tsconfig: update target to ES2023 (a6ce29d)

Tests

• index: account for arm macs (4422d9d)
• index: fix skipped test (6a1f35d)