Create and modify PDF documents in any JavaScript environment.
Designed to work in any modern JavaScript runtime. Tested in Node, Browser, Deno, and React Native environments.
## Table of Contents
- [Features](#features)
- [Usage Examples](#usage-examples)
- [Installation](#installation)
- [Documentation](#documentation)
- [License](#license)
## Features
- Modify existing PDFs
- Merge PDFs
- Rotate PDFs
- Split PDFs
- Download PDFs
- Create ZIP File Of PDFs Processed
## Usage Examples
- A Project Made Using pdf-actions is [PDFActions](https://pdfactions.vercel.app/) : [GITHUB Repo](https://github.com/ManasMadan/PDFActions)
### Merge PDFs
```js
// Importing The Required Modules
import { createPDF,pdfArrayToBlob, mergePDF } from "pdf-actions";
// Async Function To Merge PDF Files Uploaded Using The Input Tag in HTML
const mergePDFHandler = async (files) => {
// Converting File Object Array To PDF Document Array
files.forEach((file)=>await createPDF.PDFDocumentFromFile(file))
// Merging The PDF Files to A PDFDocument
const mergedPDFDocument = await mergePDF(files)
// Converting The Merged Document to Unit8Array
const mergedPdfFile = await mergedPDFDocument.save();
// Saving The File To Disk
const pdfBlob = pdfArrayToBlob(mergedPdfFile);
};
```
### Rotate PDFs
```js
// Importing The Required Modules
import { createPDF, rotatePDF, zipToBlob } from "pdf-actions";
// Async Function To Rotate PDF Files Uploaded Using The Input Tag in HTML
const rotatePDFHandler = async (files) => {
// Creating A JSZip Instance
const zip = new JSZip();
for (let i = 0; i < files.length; i++) {
const file = files[i];
const pdfDoc = await createPDF.PDFDocumentFromFile(file);
const rotatedPDF = await rotatePDF(pdfDoc, file.degrees); // file.degrees is not by default
zip.file(
`rotated-${file.name}`,
await rotatedPDF.save() // Converting To Unit8Array
);
}
const zipBlob = await zipToBlob(zip);
};
```
### Split PDFs
```js
// Importing The Required Modules
import { createPDF, splitPDF } from "pdf-actions";
import JSZip from "jszip";
// Async Function To Split PDF Files Uploaded Using The Input Tag in HTML
const splitPDFHandler = async (files) => {
// Creating A JSZip Instance
const zip = new JSZip();
for (let i = 0; i < files.length; i++) {
const file = files[i];
const pdfFile = await createPDF.PDFDocumentFromFile(file);
// Optional degree argument Default : 0
const splitPDF = await splitPDF(pdfFile, file.range, {
degree: file.degrees,
}
const pdfFile = await splitPDF.save();
zip.file(`split-${file.name}`, pdfFile);
}
await zip.generateAsync({ type: "blob" }).then(function (content) {
saveAs(content, "splitPDFFiles.zip");
});
};
```
### File To Array
```js
import { pdfArray } from "pdf-actions";
const fileArray = pdfArray(file);
```
### Pdf Array To Blob
```js
import { pdfArrayToBlob } from "pdf-actions";
const fileBlob = pdfArrayToBlob(fileArray);
```
### Zip To Blob
```js
import { zipToBlob } from "pdf-actions";
const zipBlob = zipToBlob(zipObject : JSZip Instance);
```
## Installation
### NPM Module
To install the latest stable version:
- With npm
```bash
npm install --save pdf-actions
```
- With yarn
```bash
yarn add pdf-actions
```
This assumes you're using [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/lang/en/) as your package manager.
## Documentation
The repo for the project site (and generated documentation files) is
located here: https://github.com/ManasMadan/pdf-actions
## License
[MIT](LICENSE.md)
