Poppler

Asynchronous node.js wrapper for the Poppler PDF rendering library

PDF
Fdawgs/node-popplernode-poppler

README

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:

  1. ```bash
  2. npm i node-poppler
  3. ```

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:

  1. ```
  2. sudo apt-get install poppler-data
  3. sudo apt-get install poppler-utils
  4. ```

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

  1. ```
  2. brew install poppler
  3. ```

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

  1. ```js
  2. const { Poppler } = require("node-poppler");
  3. const poppler = new Poppler("/usr/bin");
  4. ```

API


  1. ```js
  2. const { Poppler } = require("node-poppler");
  3. ```

[API Documentation can be found here](https://github.com/Fdawgs/node-poppler/blob/main/API.md)

Examples


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:

  1. ```js
  2. const { Poppler } = require("node-poppler");

  4. const file = "test_document.pdf";
  5. const poppler = new Poppler();
  6. const options = {
  7. firstPageToConvert: 1,
  8. lastPageToConvert: 2,
  9. pngFile: true,
  10. };
  11. const outputFile = `test_document.png`;

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

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:

  1. ```js
  2. const { writeFile } = require("node:fs/promises");
  3. const { Poppler } = require("node-poppler");

  5. const file = "test_document.pdf";
  6. const poppler = new Poppler();
  7. const options = {
  8. lastPageToConvert: 1,
  9. pdfFile: true,
  10. };

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

poppler.pdfToHtml


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

  1. ```js
  2. const { Poppler } = require("node-poppler");

  4. const file = "test_document.pdf";
  5. const poppler = new Poppler();
  6. const options = {
  7. firstPageToConvert: 1,
  8. lastPageToConvert: 2,
  9. };

  11. poppler
  12. .pdfToHtml(file, undefined, options)
  13. .then((res) => {
  14.   console.log(res);
  15. })
  16. .catch((err) => {
  17.   console.error(err);
  18.   throw err;
  19. });
  20. ```

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

  1. ```js
  2. const { readFileSync } = require("node:fs");
  3. const { Poppler } = require("node-poppler");

  5. const file = readFileSync("test_document.pdf");
  6. const poppler = new Poppler();
  7. const options = {
  8. firstPageToConvert: 1,
  9. lastPageToConvert: 2,
  10. };

  12. poppler
  13. .pdfToHtml(file, "tester.html", options)
  14. .then((res) => {
  15.   console.log(res);
  16. })
  17. .catch((err) => {
  18.   console.error(err);
  19.   throw err;
  20. });
  21. ```

poppler.pdfToText


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

  1. ```js
  2. const { Poppler } = require("node-poppler");

  4. const file = "test_document.pdf";
  5. const poppler = new Poppler();
  6. const options = {
  7. firstPageToConvert: 1,
  8. lastPageToConvert: 2,
  9. };

  11. poppler
  12. .pdfToText(file, options)
  13. .then((res) => {
  14.   console.log(res);
  15. })
  16. .catch((err) => {
  17.   console.error(err);
  18.   throw err;
  19. });
  20. ```

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.

License


node-poppler is licensed under the MIT license.