sails-html-pdf
Advanced tools
HTML to PDF hook for Sails JS
npm i --save sails-html-pdf
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. |
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 are generated using your configured Sails View Engine, 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).
Given the following pdf.ejs file contained in the folder views/pdfTemplates/testPdf:
<!DOCTYPE HTML>
<html>
<head>
<title>TEST</title>
</head>
<body>
<div>
<p>Hello <%=a%>!</p>
</div>
</body>
</html>
In your app you would run the following command.
sails.hooks.pdf.make(
"testPdf",
{
a: "Bob Dole",
},
{
output: 'assets/pdfs/mypdf.pdf'
},
function(err, result) {
console.log(err, result);
}
);
Or
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.
FAQs
Convert ejs template to pdf with Sails.js
We found that sails-html-pdf demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.