Skip to main content

Converter

@pdfme/converter can be used in both Node.js and in the browser.

Its primary purpose is to convert PDFs into other formats (like images) or to convert various data formats (like Markdown) into PDFs.

Although it's still under development, you can already use the following features:

  • Convert PDF to Images: pdf2img
  • Retrieve Each Page's Width and Height: pdf2size
  • Convert Images to PDF: img2pdf

Planned conversion features include:

  • Markdown to PDF: md2pdf
  • PDF to Markdown: pdf2md

Installation​

npm install @pdfme/converter

If you want to convert PDFs to images (pdf2img) in Node.js, you’ll need node-canvas (^2.11.2), which requires an additional step:

npm install canvas@^2.11.2

Features​

pdf2img​

Converts PDF pages into images (JPEG or PNG format).

import { pdf2img } from '@pdfme/converter';

const pdf = new ArrayBuffer(...); // Source PDF
const images = await pdf2img(pdf, {
  imageType: 'png',
  scale: 1,
  range: { start: 0, end: 1 },
});

pdf2size​

Retrieves the width and height of each page in a PDF.

import { pdf2size } from '@pdfme/converter';

const pdf = new ArrayBuffer(...); // Source PDF
const sizes = await pdf2size(pdf, {
  scale: 1, // Scale factor (default: 1)
});
// sizes: Array<{ width: number, height: number }>

img2pdf​

Converts one or more images (JPEG or PNG) into a single PDF file.

import { img2pdf } from '@pdfme/converter';

const image1 = new ArrayBuffer(...); // First image
const image2 = new ArrayBuffer(...); // Second image
const pdf = await img2pdf([image1, image2], {
  scale: 1,
  imageType: 'jpeg',
  size: { width: 210, height: 297 },
  margin: [10, 10, 10, 10],
});

Error Handling​

All functions throw descriptive errors when invalid parameters are provided:

  • Invalid PDF: [@pdfme/converter] Invalid PDF
  • Empty PDF: [@pdfme/converter] The PDF file is empty
  • Invalid page range: [@pdfme/converter] Invalid page range
  • Empty image array: [@pdfme/converter] Input must be a non-empty array of image buffers
  • Invalid image: [@pdfme/converter] Failed to process image

Types​

type ImageType = 'jpeg' | 'png';

interface PageRange {
  start?: number;
  end?: number;
}

interface Pdf2ImgOptions {
  scale?: number;
  imageType?: ImageType;
  range?: PageRange;
}

interface Pdf2SizeOptions {
  scale?: number;
}

interface Img2PdfOptions {
  scale?: number;
  imageType?: ImageType;
  size?: { height: number, width: number }; // in millimeters
  margin?: [number, number, number, number]; // in millimeters [top, right, bottom, left]
}

Contact​

If you have any questions or suggestions about @pdfme/converter, please reach out via: