Table of Contents

• Usage Examples
  • Modify Existing PDFs Get PDFDocument Object
    • Empty PDF Document
    • PDF Document From File
    • PDF Document From Unit8Array/ArrayBuffer
  • PDF Array from HTML File Object
  • PDF Array To Blob
  • Merge PDF
  • Rotate PDF
  • Split PDF
  • Break Single PDF File Into Multiple PDF
  • Flatten PDF Forms
  • Resize PDF
  • Add Margin to PDF
  • Edit PDF Metadata
  • Remove PDF Metadata
  • Add Page Numbers to PDF
  • JPG To PDF
• Installation
• Documentation
• License

Usage Examples

• A Project Made Using pdf-actions is PDFActions : GITHUB Repo

Modify Existing PDFs Get PDFDocument Object

To Modify Esisting PDF Files You Need to First Convert It Into a PDFDocument Object

Empty PDF Document

1import { createFileDoc } from "pdf-actions";
2
3const EmptyPDFDocument = await createFileDoc.EmptyPDFDocument();

PDF Document From File

1import { createFileDoc } from "pdf-actions";
2
3const PDFDocument = await createFileDoc.PDFDocumentFromFile(file); // file is a HTML File Object from input tag

PDF Document From Unit8Array/ArrayBuffer

1import { createFileDoc } from "pdf-actions";
2
3const PDFDocument = await createFileDoc.PDFDocumentFromPDFArray(fileArray); // fileArray is a Unit8Array/ArrayBuffer

PDF Array from HTML File Object

1import { pdfArray } from "pdf-actions";
2
3const PDFArray = await pdfArray(file); // file is a HTML File Object from input tag

PDF Array To Blob

1import { pdfArrayToBlob } from "pdf-actions";
2
3const PDFBlob = await pdfArrayToBlob(fileArray); // fileArray is a Unit8Array

Merge PDF

1import { mergePDF } from "pdf-actions";
2
3const MergedPDFDocument = await mergePDF(filesDocArray); // filesDocArray is a Array of PDFDocument Object

Rotate PDF

1import { rotatePDF } from "pdf-actions";
2
3const RotatedPDFDocument = await rotatePDF(fileDoc, degrees);
4/*
5fileDoc is a PDFDocument Object
6degrees is a integer
7*/

Split PDF

1import { splitPDF } from "pdf-actions";
2
3const SplitPDFDocument = await splitPDF(fileDoc, range, degree);
4/*
5fileDoc is a PDFDocument Object
6range : Page Numbers(both inclusive) is array of two integers - [start,stop]
7degree? is a optional parameter and integer
8*/

Break Single PDF File Into Multiple PDF

1import { breakPDF } from "pdf-actions";
2
3const BreakPDFDocumentsArray = await breakPDF(
4  fileDoc,
5  pagesInEachFile,
6  haveLastPDF,
7  degree,
8  breakRange
9);
10/*
11fileDoc is a PDFDocument Object
12pagesInEachFile is a integer denoting Number of Pages in Each Broken PDF
13haveLastPDF is a boolean to whether return the last pdf document irrespective of maxPages
14degree? is a optional parameter and integer
15breakRange? is a optional paramenter that is a array of two integers [start,stop] that splits the pdf(both inclisive) before breaking it
16*/

Flatten PDF Forms

1import { flattenPDFForm } from "pdf-actions";
2
3const PDFDocumentWithFormsFlattened = await flattenPDFForm(fileDoc);
4/*
5fileDoc is a PDFDocument Object
6*/

Resize PDF

1import { resizePDF } from "pdf-actions";
2
3const PDFDocumentWithFormsFlattened = await resizePDF(
4  fileDoc,
5  size,
6  orientation,
7  position,
8  degree
9);
10/*
11fileDoc is a PDFDocument Object
12size? optional paramenter : string : 2A0 , 4A0 , A[0-10] , B[0-10] , C[0-9] , Executive , Folio , Legal , Letter , RA[0-4] , SR[0-4] , Tabloid 
13orientation? optional paramenter : string : Portrait or Landscape
14position? optional parameter - Where The Content Should Be : string : Start , Center , End
15degree? rotate pdf angle : integer
16*/

Add Margin to PDF

1import { addMarginPDF } from "pdf-actions";
2
3const AddedMarginPDFDocument = await addMarginPDF(
4  fileDoc,
5  marginMillimeter,
6  degree
7);
8/*
9fileDoc is a PDFDocument Object
10marginMillimeter? : optional paramenter : array of length 4
11  marginMillimeter[0] -> Left
12  marginMillimeter[1] -> Top
13  marginMillimeter[2] -> Right
14  marginMillimeter[3] -> Bottom
15degree? rotate pdf angle : integer
16*/

Edit PDF Metadata

1import { editMetaData } from "pdf-actions";
2
3const NewMetaDataPDFDocument = await editMetaData(fileDoc, options);
4/*
5fileDoc is a PDFDocument Object
6options = {author,title,creator,keywords,documentCreationDate,documentModificationDate,subject,producer}
7*/

Remove PDF Metadata

1import { removeMetaData } from "pdf-actions";
2
3const RemovedMetaDataPDFDocument = await removeMetaData(fileDoc);
4/*
5fileDoc is a PDFDocument Object
6*/

Add Page Numbers to PDF

1import { addPageNumbers } from "pdf-actions";
2
3const PDFDocumentWithPageNumbers = await addPageNumbers(
4  fileDoc,
5  pageNumberPosition,
6  margin,
7  startingPage,
8  endingPage,
9  startingNumber,
10  textSize
11);
12/*
13fileDoc is a PDFDocument Object
14pageNumberPosition? : optional : is one of the following string
15  - b-l : Bottom Left
16  - b-c : Bottom Center : Default
17  - b-r : Bottom Right
18  - t-l : Top Left
19  - t-c : Top Center
20  - t-r : Top Right
21margin? : optional : is one of the following string
22  - Recommended : Default
23  - Small
24  - Big
25startingPage? : optional : is a integer should be >=1 and <=max pages in pdf
26endingPage? : optional : is a integer should be >=1 and <=max pages in pdf and >= startingPage
27startingNumber? : optional : is a integer denoting the first page number : 1 by default
28textSize? : optional 16 by default is a integer
29*/

JPG To PDF

1import { imageToPDF } from "pdf-actions";
2
3const PDFDocumentFromJPG = await imageToPDF(
4  image,
5  pageNumberPosition,
6  margin,
7  startingPage,
8  endingPage,
9  startingNumber,
10  textSize
11);
12/*
13image is a base64 data string
14pageSize? : optional : is one of the following string
15  - Same as Image
16  - 2A0 , 4A0 , A[0-10] , B[0-10] , C[0-9] , Executive , Folio , Legal , Letter , RA[0-4] , SR[0-4] , Tabloid 
17pageOrientation? : optional : should pe portrait in case of Same as Image
18imagePosition? : optional : should be Start in case of Same as Image
19degree? : rotate created PDF
20marginMillimeter? : optional paramenter : array of length 4
21  marginMillimeter[0] -> Left
22  marginMillimeter[1] -> Top
23  marginMillimeter[2] -> Right
24  marginMillimeter[3] -> Bottom
25*/

Installation

NPM Module

To install the latest stable version:

• With npm

1npm install --save pdf-actions

• With yarn

1yarn add pdf-actions

This assumes you're using npm or yarn 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