node-html-pdf
a HTML to PDF converter that wraps phantomjs
Example Business Card
-> and its Source file
var fs = require('fs');
var pdf = require('./lib');
var html = fs.readFileSync('./test/businesscard.html', 'utf8')
pdf.create(html, { width: '50mm', height: '90mm'}, function(err, buffer) {
if (err) return console.log(err);
fs.writeFile('businesscard.pdf', buffer);
});API
Currently there is only one function
var pdf = require('html-pdf');
var callback = function(err, buffer){}
pdf.create(htmlString, options, callback)Options
config = {
// Script options
script: '/url' // Absolute path to a custom phantomjs script, use the file in lib/scripts as example
timeout: 10000 // Timeout that will cancel phantomjs, in milliseconds
// Papersize Options: http://phantomjs.org/api/webpage/property/paper-size.html
"height": "", // allowed units: mm, cm, in, px
"width": "", // allowed units: mm, cm, in, px
- or -
"format": "A4", // allowed units: A3, A4, A5, Legal, Letter, Tabloid
"orientation": "portrait", // portrait or landscape
// Page options
"border": "0" // default is 0, units: mm, cm, in, px
"header": {
"height": "45mm",
"contents": '<div style="text-align: center;">Author: Marc Bachmann</div>'
},
"footer": {
"height": "28mm",
"contents": '<span style="color: #444;">{{page}}</span>/<span>{{pages}}</span>'
},
// File options
"type": "pdf", // allowed file types: png, jpeg, pdf
"quality": "75", // only used for types png & jpeg
// Export options
"buffer": true, // only supported on certain systems
- or -
"filename": "/tmp/html-pdf-123-123.pdf" // The file path of the file that will be written. If you want to save the file permanently, you have to pass this option.
"directory": "/tmp" // The directory the file gets written into if no filename is defined. default: '/tmp'
}The full options object gets converted to JSON and will get passed to the phantomjs script as third argument.
There are more options concerning the paperSize, header & footer options inside the phantomjs script.