MuhammaraJS 使用教程

MuhammaraJS 使用教程

MuhammaraJS Muhammara a node module with c/cpp bindings to modify PDF with js for node or electron (based/replacement on/of galkhana/hummusjs) 项目地址: https://gitcode.com/gh_mirrors/mu/MuhammaraJS

1. 项目介绍

MuhammaraJS 是一个基于 NodeJS 的模块，用于创建、解析和操作 PDF 文件和流。它是 HummusJS 的一个替代品，继承了 HummusJS 的优点，并对其进行了改进和扩展。MuhammaraJS 提供了丰富的 API，允许开发者方便地在 Node 或 Electron 环境中处理 PDF 文档。

2. 项目快速启动

安装

首先，确保您的系统中已安装 Node.js。然后，通过以下命令安装 MuhammaraJS：

npm install muhammara

创建新 PDF

以下是一个简单的示例，演示如何使用 MuhammaraJS 创建一个新的 PDF 文件：

const { Recipe } = require('muhammara');

const pdfDoc = new Recipe('new', 'output.pdf', {
    version: 1.6,
    author: 'John Doe',
    title: '示例 PDF',
    subject: '一个简单的 PDF 文档'
});

pdfDoc.createPage('letter').endPage();
pdfDoc.endPDF();

修改现有 PDF

要修改现有的 PDF 文件，可以使用以下代码：

const { Recipe } = require('muhammara');

const pdfDoc = new Recipe('input.pdf', 'output.pdf');

pdfDoc.editPage(1).text('这是一些添加到 PDF 的文本', 100, 100).endPage();
pdfDoc.endPDF();

3. 应用案例和最佳实践

创建带有图形和文本的 PDF

以下代码展示了如何在 PDF 中添加图形和文本：

const { Recipe } = require('muhammara');

const pdfDoc = new Recipe('new', 'output.pdf');

const page = pdfDoc.createPage('letter');
page.circle(100, 100, 50, { stroke: '#0000FF', fill: '#FF0000' });
page.text('Hello World!', 100, 100, { fontSize: 20, color: '#000000' });
page.endPage();

pdfDoc.endPDF();

加密 PDF

为了保护您的 PDF 文档，可以通过以下方式添加加密：

const { Recipe } = require('muhammara');

const pdfDoc = new Recipe('new', 'encrypted_output.pdf', {
    version: 1.6,
    author: 'John Doe',
    title: '加密 PDF',
    subject: '加密的文档',
    encryption: {
        userPassword: 'user123',
        ownerPassword: 'owner123',
        permissions: {
            printing: false,
            modifying: false,
            copying: false,
            annotating: false
        }
    }
});

pdfDoc.createPage('letter').endPage();
pdfDoc.endPDF();

4. 典型生态项目

目前，MuhammaraJS 主要用于 Node 和 Electron 项目中。以下是一些可能与之配合使用的典型生态项目：

• Electron：使用 Electron 构建桌面应用程序时，可以使用 MuhammaraJS 来处理应用程序中的 PDF 文档。
• Express：在 Express 应用程序中，可以使用 MuhammaraJS 动态生成或修改 PDF 文档，并作为响应发送给客户端。
• Puppeteer：使用 Puppeteer 进行网页自动化测试时，可以生成或修改 PDF 报告。

以上教程提供了 MuhammaraJS 的基本使用方法。更多高级功能和用例，请参考官方文档和 GitHub 仓库。

MuhammaraJS Muhammara a node module with c/cpp bindings to modify PDF with js for node or electron (based/replacement on/of galkhana/hummusjs) 项目地址: https://gitcode.com/gh_mirrors/mu/MuhammaraJS