Socket
Socket
Sign inDemoInstall

pdf-node

Package Overview
Dependencies
96
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    pdf-node

A JavaScript PDF generation library for NodeJs


Version published
Weekly downloads
139
decreased by-23.2%
Maintainers
1
Install size
10.0 MB
Created
Weekly downloads
 

Readme

Source

pdf-node

A JavaScript PDF generation library for NodeJs


📟

Install

npm install  pdf-node --save
  • Step 1 - Add required packages and read HTML template

    //Required package
    var pdf = require("pdf-node");
    var fs = require("fs");
    
    // Read HTML Template
    var html = fs.readFileSync("template.html", "utf8");
    
  • Step 2 - Create your HTML Template

    <!DOCTYPE html>
    <html>
      <head>
        <mate charest="utf-8" />
        <title>Hello world!</title>
      </head>
      <body>
        <h1>User List</h1>
        <ul>
          {{#each users}}
          <li>Name: {{this.name}}</li>
          <li>Age: {{this.age}}</li>
          <br />
          {{/each}}
        </ul>
      </body>
    </html>
    
  • Step 3 - Provide format and orientation as per your need

    "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

        var options = {
            format: "A3",
            orientation: "portrait",
            border: "10mm",
            header: {
                height: "45mm",
                contents: '<div style="text-align: center;">Author: Shyam Hajare</div>'
            },
            footer: {
                height: "28mm",
                contents: {
                    first: 'Cover page',
                    2: 'Second page', // Any page number is working. 1-based index
                    default: '<span style="color: #444;">{{page}}</span>/<span>{{pages}}</span>', // fallback value
                    last: 'Last Page'
                }
            }
        };
    
  • Step 4 - Provide HTML, user data and PDF path for output

    var users = [
      {
        name: "tom",
        age: "21",
      },
      {
        name: "dick",
        age: "23",
      },
      {
        name: "harry",
        age: "29",
      },
    ];
    var document = {
      html: html,
      data: {
        users: users,
      },
      path: "./output.pdf",
      type: "pdf",
    };
    
    
  • Step 5- After setting all parameters, just pass document and options to pdf.create method.

    pdf(document, options)
      .then((res) => {
        console.log(res);
      })
      .catch((error) => {
        console.error(error);
      });
    

Reference

Please refer to the following if you want to use conditions in your HTML template:


Connect

GitHub @tawseefnabi (follow) To stay up to date on free & open-source software

Twitter @NabiTowseef (follow) To get tech updates/small>

LinkedIn @TawseefAhmad (connect) On the LinkedIn profile y'all


Keywords

FAQs

Last updated on 10 Dec 2022

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc