node-poppler

node-poppler

Intro

The node-poppler module was created out of a need for a PDF-to-HTML conversion tool at Yeovil District Hospital NHSFT to convert clinical documents to HTML. This allows the documents to be dispatched electronically via the NHS MESH system to other NHS bodies.

There are a number of other Poppler wrapper modules available but the majority are no longer maintained or did not provide full interfacing with the Poppler binaries (i.e. only provided an interface to the PDF-to-Cairo binary but not to HTML).

What is Poppler?

Poppler is an open-source software utility library for rendering PDF documents; poppler-utils are a collection of binaries built on Poppler for manipulating, extracting from, and converting PDF documents to a variety of formats including HTML, PNG, JPEG, TIFF, PDF, PS, EPS, SVG, BMP, and TXT.

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

API Documentation can be found here

Example uses

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:

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

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

await poppler.pdfToCairo(options, file).then((res) => {
	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
};

await 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
};

await 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.5.0 (2020-01-19)

• chore: bump typescript from 3.7.4 to 3.7.5 (6f5230a)
• chore: increment minor version number (b38cf5a)
• chore: upgrade dependencies (f15b8dc)
• style: tidy whitespace (8f4bd44)
• docs: add changelog (43c85d0)
• docs: add contributing guide (ea71f0a)
• docs: add contributing section (8667834)
• docs: add links to node.js and yarn (4eda8ca)
• docs: add Linux support section (2c331db)
• docs: add pdfImages function (fba0644)
• docs: fix link to issues path (bb76b79)
• docs: tidy punctuation (aa0c482)
• docs: update README.md (9017e54)
• docs(pdfImages): add note about outputPath param (8a83820)
• fix(pdfImages): add if statement for outputPath param (acd0277)
• test(pdfImages): add pdfImages function tests (fea63cf)
• feat: add changelog generation (b310b67)
• feat(pdfImages): add pdfImages function (48beb2d)