node-poppler

node-poppler

Asynchronous node.js wrapper for the Poppler PDF rendering library

Intro

The node-poppler module was created out of a need for a PDF-to-HTML conversion module at Yeovil District Hospital NHS Foundation Trust to convert clinical documents in PDF format to HTML.

Installation

Install using yarn:

yarn add node-poppler

Or npm:

npm install node-poppler

node-poppler's test scripts use yarn commands.

Linux and macOS/Darwin support

Windows and macOS/Darwin 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
sudo apt-get install poppler-utils

If you do not wish to use the included macOS binaries, you can download the latest versions with Homebrew:

brew install poppler

Once they have been installed, you will need to pass the poppler-utils installation directory in as parameters to an instance of the Poppler class:

const { Poppler } = require("node-poppler");
const poppler = new Poppler("./usr/bin");

API

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

API Documentation can be found here

Examples

poppler.pdfToCairo

options object requires at least one of the following to be set: jpegFile; pdfFile; pngFile; psFile; svgFile; tiffFile.

Example of an async await call 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);

poppler.pdfToHtml

Every field of the options object is optional.

Example of calling poppler.pdfToHtml with a promise:

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

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

poppler.pdfToHtml(file, options).then((res) => {
	console.log(res);
});

poppler.pdfToText

Every field of the options object is entirely optional.

Example of calling poppler.pdfToText with a promise:

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

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

poppler.pdfToText(file, options).then((res) => {
	console.log(res);
});

Contributing

Please see CONTRIBUTING.md for more details regarding contributing to this project.

License

node-poppler is licensed under the MIT license.

Changelog

2.1.2 (2020-12-28)

• build: update github-actions with dependabot (ec8bf01)
• build(deps-dev): bump eslint from 7.15.0 to 7.16.0 (de68d3d)
• build(deps-dev): bump eslint-config-prettier from 7.0.0 to 7.1.0 (1840406)
• build(deps-dev): bump eslint-plugin-jsdoc from 30.7.8 to 30.7.9 (763e676)
• build(deps-dev): remove eslint-plugin-json (faccfa6)
• build(deps): bump fastify/github-action-merge-dependabot (#180) (95de123), closes #180
• build(deps): bump node-notifier from 8.0.0 to 8.0.1 (25c3ffe)
• build(typescript): enable strict option (87c221e)
• ci: add linting job; expand scope of jobs (0b2412c)
• ci: add typescript compilation step (94654e6)
• ci: automatically merge dependabot pull requests on pass build stage (105b2f3)
• ci: bump actions/setup-node from v1 to v2 (f19f5b8)
• ci: do not run github actions for draft prs (c76d373)
• ci: merge unit test jobs (73f6ccc)
• ci: move dependency installs to correct step (bbdeb60)
• ci: reorder lint steps (b8aca23)
• ci: require lint job on automerge (1fd4523)
• ci: use yarn --frozen-lockfile flag for repro deps (dfc2c31)
• style: use default prettier options for trailing commas and quotes (b8e791d)
• style(ci): remove whitespace (8b9150e)
• fix(scripts): test script (cf4ccd2)
• chore(scripts): rename test scripts (c8a2c69)
• docs(readme): remove abbreviation (715fc9d)