QuickPDF

Handling PDFs in NodeJS (📃 to 🖼️)

This project provides a set of utilities for converting various file formats without the need for additional dependencies. It supports multiple file types and leverages technologies like Puppeteer and PDFKit for file processing.

Features

• HTML to PDF: Converts HTML content (from a URL or file path) into a PDF.
• Image to PDF: Converts images (JPEG, PNG) into a PDF, with optional headers and footers.
• PDF to Image: Converts PDF files to image formats (JPEG or PNG) using pdfjs-dist and canvas.
• Utilities: Includes helper functions to fetch and read HTML files and read files from local directories.

Requirements

• Node.js: This project is built with Node.js and uses ES modules. NodeJS > v22 required.
• Chromium is a dependency of this project, used via Playwright. To install browsers via cli run npx playwright install --with-deps chromium. If running in a ci enviroment you can include --only-shell

Operations Available in the Package

1. html2pdf

Function Signature:

html2pdf(input: string | URL)

Validation occurs on the html string passed. The Error Object returned is:

  {
    valid: boolean,
    count: {
      errors: number,
      warnings: number
    },
    validation: [ {
      file: string,
      count: {
        errors: number,
        warnings: number
      },
      messages: [ {
        message: string,
        line: number,
        column: number,
        ruleId: string
      } ]
    } ]
  }

Parameters:

Options Type:

2. img2pdf

Function Signature:

img2pdf(input: Buffer | string | URL, options: Options = {})

Parameters:

Options Type:

3. pdf2img

Function Signature:

pdf2img(input: Buffer | string | URL, options: Options = {})

Parameters:

Options Type: