wkhtmltopdf0.3.4 • Public • Published
A Node.js wrapper for the wkhtmltopdf command line tool. As the name implies, it converts HTML documents to PDFs using WebKit.
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. DO NOT 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
Be sure the
wkhtmltopdf command line tool is in your PATH when you're done installing. If you don't want to do this for some reason, you can change
require('wkhtmltopdf').command property to the path to the
wkhtmltopdf command line tool.
wkhtmltopdf(source, [options], [callback]);
var wkhtmltopdf = ;// URL;// HTML;// Stream input and outputvar stream = ;// output to a file directly;// Optional callback;// Repeatable options;// Ignore warning strings;// RegExp also acceptable;
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
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.