Skip to content

(integration) pdf2image is a lightweight JavaScript library to convert PDF pages into images (PNG, JPG, WebP) with real-time progress tracking and optional ZIP compression.

License

Notifications You must be signed in to change notification settings

pardnchiu/pdf2image

Repository files navigation

pdf2image

tag size
npm download jsdeliver

Features

PDF to Images

  • Seamlessly integrates with pdf.js to efficiently parse PDFs and convert them into images.
  • Supports multiple image formats: jpg, png, webp for versatile usage.

Compressed Downloads

  • Leverages jszip.js to bundle generated images into a ZIP file for one-click download.
  • Automatically names files and ZIP archives for better organization of multipage content.

High Efficiency and Stability

  • Designed with asynchronous processing to ensure a smooth user experience.
  • Comprehensive error handling with detailed error messages for easier debugging.

Installation

Install via npm

npm i @pardnchiu/pdf2image

Include via CDN

UMD Version

<script src="https://cdn.jsdelivr.net/npm/@pardnchiu/pdf2image@[VERSION]/dist/pdf2image.js"></script>

ES Module Version

import { pdf2image } from "https://cdn.jsdelivr.net/npm/@pardnchiu/pdf2image@[VERSION]/dist/pdf2image.esm.js";

How to use

Initialize pdf2image

const converter = new pdf2image({
    filename: "image-yyyy-MM-DD_hh:mm", // Specify output filename, supports date format templates [yyyy|MM|DD|hh|mm]
    file: [file],                       // Input PDF file from file input or other sources
    scale: 1.5,                         // Scale factor, default is 1.5
    type: "png"                         // Output image format [jpg|png|webp]
});

// Convert PDF to images
converter.convert().then(images => {
    console.log("Successfully converted images:", images);
});

// Download compressed ZIP file
converter.download().then(() => {
    console.log("Images have been packed and downloaded!");
});

License

This source code project is licensed under the MIT License.

Creator

邱敬幃 Pardn Chiu


©️ 2024 邱敬幃 Pardn Chiu

About

(integration) pdf2image is a lightweight JavaScript library to convert PDF pages into images (PNG, JPG, WebP) with real-time progress tracking and optional ZIP compression.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published