PDFME项目中的文档转换器使用指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00422/article/details/148601922

PDFME项目中的文档转换器使用指南

pdfme A TypeScript based PDF generator library, made with React. 项目地址: https://gitcode.com/gh_mirrors/pd/pdfme

概述

PDFME项目中的@pdfme/converter模块是一个功能强大的文档转换工具，它能够在Node.js和浏览器环境中实现PDF与其他格式之间的相互转换。本文将详细介绍该模块的主要功能、使用方法以及最佳实践。

核心功能

1. PDF转图片功能

pdf2img功能可以将PDF文档的每一页转换为图片格式（支持JPEG和PNG），非常适合需要将PDF内容可视化展示的场景。

使用示例：

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

const pdfBuffer = new ArrayBuffer(...); // 原始PDF数据
const images = await pdf2img(pdfBuffer, {
  imageType: 'png',  // 输出图片格式
  scale: 1.5,        // 缩放比例
  range: { start: 0, end: 2 }, // 转换页码范围
});

参数说明：

imageType：指定输出图片格式，可选'jpeg'或'png'
scale：图片缩放比例，1表示原始大小
range：指定转换的页码范围，start从0开始

2. 获取PDF页面尺寸

pdf2size功能可以快速获取PDF文档中每一页的尺寸信息，对于需要精确控制PDF布局的应用非常有用。

使用示例：

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

const sizes = await pdf2size(pdfBuffer, {
  scale: 1 // 缩放因子
});
// 返回结果示例: [{width: 595, height: 842}, ...]

3. 图片转PDF功能

img2pdf功能可以将多张图片合并为一个PDF文档，支持自定义页面大小和边距。

使用示例：

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

const imageBuffers = [image1, image2]; // 图片数组
const pdf = await img2pdf(imageBuffers, {
  scale: 1,
  imageType: 'jpeg',
  size: { width: 210, height: 297 }, // A4尺寸(毫米)
  margin: [10, 10, 10, 10], // 页边距[上,右,下,左]
});

安装与配置

基础安装

npm install @pdfme/converter

Node.js环境额外配置

如需在Node.js环境中使用PDF转图片功能，需要额外安装canvas库：

npm install canvas@^2.11.2

错误处理指南

模块提供了详细的错误提示，帮助开发者快速定位问题：

无效PDF文件：检查PDF文件是否损坏
空PDF文件：确认PDF包含有效内容
无效页码范围：确保指定的页码范围在文档范围内
空图片数组：确认输入包含至少一张图片
图片处理失败：检查图片格式是否支持

类型定义参考

模块提供了完整的TypeScript类型定义：

// 图片类型
type ImageType = 'jpeg' | 'png';

// 页码范围
interface PageRange {
  start?: number;
  end?: number;
}

// PDF转图片选项
interface Pdf2ImgOptions {
  scale?: number;
  imageType?: ImageType;
  range?: PageRange;
}

// 图片转PDF选项
interface Img2PdfOptions {
  scale?: number;
  imageType?: ImageType;
  size?: { height: number; width: number }; // 毫米单位
  margin?: [number, number, number, number]; // 毫米单位[上,右,下,左]
}