# pdf-merger-js > merge multiple PDF documents, or parts of them, to a new PDF document Latest version **5.1.2** (published 2024-06-17) · MIT license · 0 weekly downloads ## Install ```sh npm install pdf-merger-js pnpm add pdf-merger-js yarn add pdf-merger-js bun add pdf-merger-js ``` Provides the command `pdf-merge`. ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 5.1.2 | | Published | 2024-06-17 | | First published | 2019-04-23 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=14 | | Dependencies | 2 | | Unpacked size | 2.5 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 303 | | Author | nbesli | | Maintainers | mojoaxel, nbesli | | Keywords | pdf, merge | ## Links - npm: https://www.npmjs.com/package/pdf-merger-js - Repository: https://github.com/nbesli/pdf-merger-js - Homepage: https://github.com/nbesli/pdf-merger-js#readme - Issues: https://github.com/nbesli/pdf-merger-js/issues - npm.io page: https://npm.io/package/pdf-merger-js ## Dependencies (2) - [pdf-lib](https://npm.io/package/pdf-lib.md) ^1.17.1 - [commander](https://npm.io/package/commander.md) ^11.1.0 ## Alternatives - [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads - [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads - [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads - [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads - [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads ## Recent versions - 5.1.2 (latest) — 2024-06-17 - 5.1.1 — 2024-01-27 - 5.1.0 — 2024-01-27 - 5.0.0 — 2023-12-26 - 4.3.1 — 2023-12-25 - 4.3.0 — 2023-03-21 - 4.2.1 — 2023-03-01 - 4.2.0 — 2022-12-09 - 4.1.2 — 2022-10-13 - 4.1.1 — 2022-09-13 - 4.1.0 — 2022-08-26 - 4.0.1 — 2022-08-26 - 4.0.0 — 2022-08-12 - 3.4.0 — 2022-02-21 - 3.3.2 — 2022-01-19 - … 13 more at https://npm.io/package/pdf-merger-js/versions ## README # Description This node.js library can **merge multiple PDF documents**, or parts of them, to one new PDF document. You can do this by using the **command line interface** or from within your **node.js** or even directly in the **browser**. The only dependency is [pdf-lib](https://pdf-lib.js.org/) so it can run in any javascript-only environment **without any non-javascript dependencies**. ## Legacy notes * If you are searching for the legacy version based on [pdfjs](https://www.npmjs.com/package/pdfjs) please install a [v3 release](https://github.com/nbesli/pdf-merger-js/releases?q=v3&expanded=true). Since [v4](https://github.com/nbesli/pdf-merger-js/releases?q=v4&expanded=true) we use [pdf-lib](https://pdf-lib.js.org/) instead. * If you are searching for a legacy version using CommonJS modules please install a [v4 release](https://github.com/nbesli/pdf-merger-js/releases?q=v4&expanded=true). Since [v5](https://github.com/nbesli/pdf-merger-js/releases?q=v5&expanded=true) we use the modern ESM ("import") instead of the CommonJS ("require) module standard. ## Installation `npm install --save pdf-merger-js` or simply do a global installation if you just want to use the cli tool: `npm install -g pdf-merger-js` ## Usage ### CLI "pdf-merge" ```txt Usage: pdf-merge [options] merge multiple PDF documents, or parts of them, to a new PDF document Options: -V, --version output the version number -o, --output Merged PDF output file path -v, --verbose Print verbose output -s, --silent do not print any output to stdout. Overwrites --verbose -h, --help display help for command ``` #### Example calls Merge pages 1-2 from the first input with pages 1,2 and 5-7 from the second pdf document: `pdf-merge --output ./merged.pdf ./input1.pdf#1-2 ./input2.pdf#1,2,5-7` Get two pdf files from the an url and merge the first one with pages 2-3 from the second one: `pdf-merge --verbose --output ./sample.pdf Testfile.pdf https://pdfobject.com/pdf/sample.pdf https://upload.wikimedia.org/wikipedia/commons/1/13/Example.pdf#2-3` ### node.js The node.js version has the following export functions: * `saveAsBuffer` exports a merged pdf as an [Buffer](https://nodejs.org/api/buffer.html). * `save` saves the pdf under the given filename. * `setMetadata` set Metadata for producer, author, title or creator. * `reset` resets the internal state of the document, to start again. #### async node.js example ```js import PDFMerger from 'pdf-merger-js'; var merger = new PDFMerger(); (async () => { await merger.add('pdf1.pdf'); //merge all pages. parameter is the path to file and filename. await merger.add('pdf2.pdf', 2); // merge only page 2 await merger.add('pdf2.pdf', [1, 3]); // merge the pages 1 and 3 await merger.add('pdf2.pdf', '4, 7, 8'); // merge the pages 4, 7 and 8 await merger.add('pdf3.pdf', '3 to 5'); //merge pages 3 to 5 (3,4,5) await merger.add('pdf3.pdf', '3-5'); //merge pages 3 to 5 (3,4,5) // Set metadata await merger.setMetadata({ producer: "pdf-merger-js based script", author: "John Doe", creator: "John Doe", title: "My live as John Doe" }); await merger.save('merged.pdf'); //save under given name and reset the internal document // Export the merged PDF as a nodejs Buffer // const mergedPdfBuffer = await merger.saveAsBuffer(); // fs.writeSync('merged.pdf', mergedPdfBuffer); })(); ``` ### Browser The Browser version has the following export functions: * `saveAsBuffer` exports a merged pdf as an [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array). * `saveAsBlob` exports a merged pdf as a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob). * `save` starts a file-download directly in the browser. * `setMetadata` set Metadata for producer, author, title or creator. * `reset` resets the internal state of the document, to start again. #### async react example ```jsx import PDFMerger from 'pdf-merger-js/browser'; import React, { useEffect, useState } from 'react'; // files: Array of PDF File or Blob objects const Merger = (files) => { const [mergedPdfUrl, setMergedPdfUrl] = useState(); useEffect(() => { const render = async () => { const merger = new PDFMerger(); for(const file of files) { await merger.add(file); } await merger.setMetadata({ producer: "pdf-merger-js based script" }); const mergedPdf = await merger.saveAsBlob(); const url = URL.createObjectURL(mergedPdf); return setMergedPdfUrl(url); }; render().catch((err) => { throw err; }); () => setMergedPdfUrl({}); }, [files, setMergedPdfUrl]); return !data ? ( <>Loading ) : ( ); }; ``` ## Similar libraries * This library is inspired by the [PHP library PDFMerger](https://github.com/myokyawhtun/PDFMerger) and has a very similar API. * [pdf-merge](https://www.npmjs.com/package/pdf-merge) has a dependency on [PDFtk](https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/). * [easy-pdf-merge](https://www.npmjs.com/package/easy-pdf-merge) has a dependency on the [Apache PDFBox® - A Java PDF Library](https://pdfbox.apache.org/). * [pdfmerge](https://www.npmjs.com/package/pdfmerge) has a dependency on python and [PyPDF2](https://pythonhosted.org/PyPDF2/). --- _Source: https://npm.io/package/pdf-merger-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._