Skip to content
master
Go to file
Code

README.md

node-poppler

GitHub Release npm version Build Status Coverage Status Known Vulnerabilities code style: prettier

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 NHSFT 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.

You can’t perform that action at this time.