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 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 support

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

An example of downloading the binaries on a Debian system:

sudo apt-get install poppler-data
sudo apt-get install poppler-utils

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 atleast one of the following to be set: jpegFile; pdfFile; pngFile; psFile; svgFile; tiffFile.

Example of calling poppler.pdfToCairo with a promise, 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 res = await poppler.pdfToCairo(options, file);
console.log(res);

poppler.pdfToHtml

Every field of the options object is entirely 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(options, file).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(options, file).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

1.7.4 (2020-06-29)

• chore: add missing jsdoc tags for test function (770109e)
• chore: create code_of_conduct.md (9a3a264)
• chore(eslint): convert from json to js file format (a6e7f04)
• chore(eslint): move inline eslint rules into config file (99fe5be)
• chore(eslint): reorder rules (96f561b)
• chore(index): add jsdoc descriptions for params to parseoptions function (3915895)
• chore(scripts): remove prettier ignore-path option (e65419c)
• build(deps-dev): bump @commitlint/config-conventional (6821f42)
• build(deps-dev): bump eslint from 7.2.0 to 7.3.1 (cda023a)
• build(deps-dev): bump eslint-plugin-jest from 23.13.2 to 23.17.1 (c8ab3f7)
• build(deps-dev): bump eslint-plugin-jsdoc from 27.0.7 to 28.5.1 (87ca360)
• build(deps-dev): bump jest from 26.0.1 to 26.1.0 (c7868dc)
• Create Dependabot config file (0dff433)
• refactor: replace promise syntax with async await (5e6c1e4)
• refactor(index): move args array inside parseoptions function (41c44ef)