A wrapper for the wkhtmltopdf HTML to PDF converter using WebKit
A Node.js wrapper for the wkhtmltopdf command line tool. As the name implies, it converts HTML documents to PDFs using WebKit.
var wkhtmltopdf = require'wkhtmltopdf';// URLwkhtmltopdf'' pageSize: 'letter'pipefscreateWriteStream'out.pdf';// HTMLwkhtmltopdf'<h1>Test</h1><p>Hello world</p>'piperes;// Stream input and outputvar stream = wkhtmltopdffscreateReadStream'file.html';// output to a file directlywkhtmltopdf'' output: 'out.pdf' ;// Optional callbackwkhtmltopdf'' pageSize: 'letter'// do whatever with the stream;// Repeatable optionswkhtmltopdf''allow : 'path1' 'path2'customHeader :'name1' 'value1''name2' 'value2';// Ignore warning stringswkhtmltopdf''output: 'out.pdf'ignore: 'QFont::setPixelSize: Pixel size <= 0 (0)';// RegExp also acceptablewkhtmltopdf''output: 'out.pdf'ignore: /QFont::setPixelSize/;
wkhtmltopdf is just a function, which you call with either a URL or an inline HTML string, and it returns
a stream that you can read from or pipe to wherever you like (e.g. a file, or an HTTP response).
There is also an
output option that can be used to write the output directly to a filename, instead of returning
First, you need to install the wkhtmltopdf command line tool on your system. The easiest way to do this is to download a prebuilt version for your system. Don't try to use the packages provided by your distribution as they may not be using a patched Qt and have missing features.
Finally, to install the node module, use
npm install wkhtmltopdf
wkhtmltopdf is in your PATH when you're done installing. If you don't want to do this for some reason, you can change
wkhtmltopdf.command property to the path to the
wkhtmltopdf command line tool.
npm test and manually check that generated files are like the expected files. The test suit prints the paths of the files that needs to be compared.
TODO - Find a way to automatically compare the PDF files.