PDF-Puppeteer

A simple npm package to convert HTML to PDF for Node.js applications by using Puppeteer

Getting Started

Installation

To use PDF-Puppeteer in your Node app:

npm install --save pdf-puppeteer   
# or "yarn add pdf-puppeteer"

Requirements

Node 7.6.0 or greater.

Usage

First, include the convertHTMLToPDF from the package in your .js file:

const convertHTMLToPDF = require("pdf-puppeteer");

var callback = function (pdf) {
    // do something with the PDF like send it as the response
    res.setHeader("Content-Type", "application/pdf");
    res.send(pdf);
}

/**
*    Usage
*    @param html - This is the html to be converted to a pdf
*    @param callback - Do something with the PDF
*    @param [options] - Optional parameter to pass in Puppeteer PDF options
*/
convertHTMLToPDF(html, callback, options);

The convertHTMLToPDF function takes the three parameters detailed above. For more information on the available Puppeteer options for PDF's take a look at Puppeteer's Page PDF Options. More details on usage can be found by checking out the example in the repo.

Example

To run the example in the repo: clone the repo, npm install on the package, npm install on the example, and run the app:

git clone https://github.com/westmonroe/pdf-puppeteer.git  
cd pdf-puppeteer
npm install
cd example
npm install
node index.js

Once the example is running, the PDF route can be tested using Postman. In the example folder, you will find a Postman collection called PDF-Puppeteer.postman_collection.json with the test routes and test html included.