Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

@divvit/html-data-to-pdf-utils

0.6.1 • Public • Published

@divvit/html-data-to-pdf-utils for NodeJS

Simple and lightweight HTML to text conversion using Node and PhantomJS.

Installation

npm install @divvit/html-data-to-pdf-utils

v0.5.0 Stable

Dependencies

  1. PhantomJS
  2. Async
  3. Temp
  4. Debug

Conversion API

The API exposes a single function 'convert'. Using this function, you can input a multitude of settings, which are further specified below:

var pdf = require('@divvit/html-data-to-pdf-utils');
 
pdf.convert(options, function(result) {
 
    /* Using a buffer and callback */
    result.toBuffer(function(returnedBuffer) {});
 
    /* Using a readable stream */
    var stream = result.toStream();
 
    /* Using the temp file path */
    var tmpPath = result.getTmpPath();
 
    /* Using the file writer and callback */
    result.toFile("/path/to/file.pdf", function() {});
});

Options

Calling convert() requires an options object, which includes the following definitions:

{
    "html" : "Path to HTML file",
    "data" : "Json data passer in html file",
    "css" : "Path to additional CSS file",
    "js" : "Path to additional JavaScript file",
    "runnings" : "Path to runnings file. Check further below for explanation.",
    "paperSize" : "Two ways to do this, see below",
    "deleteOnAction" : "true/false (Deletes the created temp file once you access it via toBuffer() or toFile())"
}

Instead of paths, one can also provide properly escaped source code.

Paper Size

Either supply a paper format, orientation and border (this is the default)

{format: 'A4', orientation: 'portrait', border: '1cm'}

Or supply a page width, height and border.

{width: '3in', height: '2in', border: '0.5in'}

See link below for accepted units and formats

Tests

npm test

Contributing

Anh Nguyen, Nino Ulsamer, Divvit AB

License

MIT

Release History

  • 0.1.0 Initial release
  • 0.5.0 fixed bug release

install

npm i @divvit/html-data-to-pdf-utils

Downloadsweekly downloads

6

version

0.6.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability