Neutrino Packing Machine
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    html-pdf-wth-renderingpublic

    node-html-pdf

    a HTML to PDF converter that wraps phantomjs

    image
    Example Business Card
    -> and its Source file

    Example Receipt

    Example

    var fs = require('fs');
    var pdf = require('html-pdf');
    var html = fs.readFileSync('./test/businesscard.html', 'utf8')
    var options = { format: 'Letter' };
     
    pdf.create(html, options).toFile('./businesscard.pdf', function(err, res) {
      if (err) return console.log(err);
      console.log(res); // { filename: '/app/businesscard.pdf' }
    });

    API

    var pdf = require('html-pdf');
    pdf.create(html).toFile([filepath, ]function(err, res){
      console.log(res.filename);
    });
     
    pdf.create(html).toStream(function(err, stream){
      stream.pipe(fs.createWriteStream('./foo.pdf'));
    });
     
    pdf.create(html).toBuffer(function(err, buffer){
      console.log('This is a buffer:', Buffer.isBuffer(buffer));
    });
     
     
    // for backwards compatibility
    // alias to pdf.create(html[, options]).toBuffer(callback)
    pdf.create(html [, options], function(err, buffer){});

    Options

    config = {
     
      // Export options
      "directory": "/tmp",       // The directory the file gets written into if not using .toFile(filename, callback). default: '/tmp'
     
      // Papersize Options: http://phantomjs.org/api/webpage/property/paper-size.html
      "height": "10.5in",        // allowed units: mm, cm, in, px
      "width": "8in",            // allowed units: mm, cm, in, px
      - or -
      "format": "Letter",        // 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
      - or -
      "border": {
        "top": "2in",            // default is 0, units: mm, cm, in, px
        "right": "1in",
        "bottom": "2in",
        "left": "1.5in"
      },
     
      "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
     
      // Script options
      "phantomPath": "./node_modules/phantomjs/bin/phantomjs", // PhantomJS binary which should get downloaded automatically
      "phantomArgs": [], // array of strings used as phantomjs args e.g. ["--ignore-ssl-errors=yes"]
      "script": '/url',           // Absolute path to a custom phantomjs script, use the file in lib/scripts as example
      "timeout": 30000           // Timeout that will cancel phantomjs, in milliseconds
     
    }

    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.

    install

    npm i html-pdf-wth-rendering

    Downloadsweekly downloads

    2

    version

    1.2.2

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar