pdf-to-images

A simple and robust Node.js package to convert PDF pages into high-quality images (PNG/JPEG) using pdfjs-dist and node-canvas.

Features

• Converts each page of a PDF into a separate image.
• Supports PNG and JPEG formats.
• Customizable scaling (DPI) for high-quality output.
• Programmatic API and Command Line Interface (CLI).
• ESM and TypeScript support.

Installation

npm install pdf-to-images

Note: This package requires canvas which may need some system dependencies. See node-canvas installation for details.

Usage

Programmatic API (ESM)

import { pdfToImages } from 'pdf-to-images';

const options = {
  outputDir: './output',
  format: 'png', // 'png' or 'jpeg'
  scale: 2,      // 2x scale for better quality
};

try {
  const images = await pdfToImages('path/to/your.pdf', options);
  console.log('Generated images:', images);
} catch (error) {
  console.error('Error:', error);
}

Command Line Interface (CLI)

After installing globally or using npx:

pdf-to-img <input.pdf> -o <output_dir> -f <format> -s <scale>

Options:

• -o, --output <dir>: Output directory (default: ./output)
• -f, --format <ext>: Output format (png or jpeg, default: png)
• -s, --scale <number>: Scale for conversion (default: 2)
• -q, --quality <number>: Quality for JPEG (0 to 1, default: 0.9)

Using a Configuration File

You can also use a configuration file (pdf-to-images.config.ts) to manage your settings.

1. Initialize the config file:

   pdf-to-img init

2. Edit pdf-to-images.config.ts to set your paths:

   export default {
     pdfPath: './my-document.pdf',
     outputDir: './images',
     scale: 2
   };

3. Run without arguments:

   pdf-to-img

Development

1. Clone the repository.
2. Install dependencies: npm install
3. Build the project: npm run build
4. Test with a sample PDF: npm run test

License

ISC