const pdfEssentials = require('./pdf-essentials-js');
const newPDF = new pdfEssentials();

(async () => {
    // pass PDF path or PDF Buffer

    // add all the pages of sample pdf
    await newPDF.add('sample.pdf');
    // add 2nd page of PDF
    await newPDF.add('sample.pdf', 2);
    // add 3rd & 6th page
    await newPDF.add('sample.pdf', [3,6]);
    // add 2 , 3 , 4 , 5 to PDF
    await newPDF.add('sample.pdf', "2 to 5");
    // add 2, 3, 4, 5 to PDF
    await newPDF.add('sample.pdf', '2 - 5');
    
    // return Buffer of merged PDFs
    const buffer = await newPDF.saveAsBuffer();
    //or Download mreged PDF. Pass filename / path 
    await newPDF.save('merged.pdf');

})();

Split PDF

async node.js example

const pdfEssentials = require('./pdf-essentials-js');
const pdfFunctions = new pdfEssentials();

(async () => {
    // First parameter - pdf path
    /* Second parameter - ranges in which pdfs have to be split. 
     Must pass in a array, any number of pairs [1, 5] is refered as a pair. */ 
    /* return array of Buffers of PDFs. 
    Number of buffer in array recieved is equal to number of elements of pairs in array we passed. */
    const buffer = await pdfFunctions.split('sample.pdf', [[1,5], [6, 10]]);
})();

HTML to PDF

async node.js example

const pdfEssentials = require('./pdf-essentials-js');
const pdfFunctions = new pdfEssentials();

(async ()=>{
    // convert the given HTML Code into PDF, and return PDF Buffer
    const htmlCode = 
        `<!DOCTYPE html>
        <html lang="en">
        <head>
            <title>Pdf Essentials</title>
        </head>
        <body>
            This is sample PDF created by <a href="http://www.pdfessentials.com">PDF Essentials</a> 
        </body>
        </html>`
    try {
        // pass your HTML Code
        // returns buffer of PDF
        const buffer = await pdfFunctions.htmlToPDF(htmlCode)
    
        // if you want to download file else use buffer
        const fs = require('fs').promises
        // download PDF 
        await fs.writeFile('file.pdf' , buffer)
    } catch (error) {
        // returns if any error occur
        console.log(error)
    }
})();

URL to PDF

async node.js example

const pdfEssentials = require('./pdf-essentials-js');
const pdfFunctions = new pdfEssentials();

(async ()=>{
    try {
        // returns buffer of PDF
        const buffer = await pdfFunctions.urlToPDF("https://www.google.com");
        
        // if you want to download file else use buffer
        const fs = require('fs').promises
        // download PDF 
        await fs.writeFile('file.pdf' , buffer)
    } catch (error) {
        console.log(error)
    }
})();

Upcoming Functionalties

Images to PDF
Compress PDF
Protect PDF
Add Watermark

Support

Contribute to the code. Help us increase functionalties.
Dont hesitate to create Issues

Keywords

FAQs

What is pdf-essentials-js?

Is pdf-essentials-js popular?

Is pdf-essentials-js well maintained?

Package last updated on 04 Oct 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

pdf-essentials-js

pdf-essentials-js

Installation

Current Functionalities:

Usage

Merge PDF

async node.js example

Split PDF

async node.js example

HTML to PDF

async node.js example

URL to PDF

async node.js example

Upcoming Functionalties

Support

Keywords

Related posts

Supply Chain Attack on Axios Pulls Malicious Dependency from npm

TeamPCP Compromises Telnyx Python SDK to Deliver Credential-Stealing Malware