# sails-html-pdf
HTML to PDF hook for [Sails JS](http://sailsjs.org)
### Installation
`npm i --save sails-html-pdf`
### Usage
`sails.hooks.pdf.make(template, data, options, cb)`
Parameter | Type | Details
-------------- | ------------------- |:---------------------------------
template | string | Relative path from `templateDir` (see "Configuration" below) to a folder containing pdf templates.
data | object | Data to use to replace template tokens
options | object | Pdf options (right now just output)
cb | function | Callback to be run after the pdf is created (or if an error occurs). It will contain the path to the file.
### Configuration
By default, configuration lives in `sails.config.pdf`. The configuration key (`pdf`) can be changed by setting `sails.config.hooks['sails-hook-pdf'].configKey`.
Parameter | Type | Details
-------------- | ------------------- |:---------------------------------
templateDir | string | Path to view templates relative to `sails.config.appPath` (defaults to `views/pdfTemplates`)
### Templates
Templates are generated using your configured Sails [View Engine](http://sailsjs.org/#!/documentation/concepts/Views/ViewEngines.html), allowing for multiple template engines and layouts. If Sails Views are disabled, will fallback to EJS templates. To define a new email template, create a new folder with the template name inside your `templateDir` directory, and add an **pdf.ejs** file inside the folder (substituting .ejs for your template engine).
### Example
Given the following **pdf.ejs** file contained in the folder **views/pdfTemplates/testPdf**:
```html
TEST
```
In your app you would run the following command.
```javascript
sails.hooks.pdf.make(
"testPdf",
{
a: "Bob Dole",
},
{
output: 'assets/pdfs/mypdf.pdf'
},
function(err, result) {
console.log(err, result);
}
);
```
Or
```javascript
sails.hooks.pdf.make("testPdf",
{
a: "Bob Dole",
},
{
output: 'assets/pdfs/mypdf.pdf'
}).then(function(result) {
console.log(result);
}).catch(function(error) {
console.log(error);
});
```
will result in creating the pdf.