Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 42 additions & 50 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,56 +4,48 @@

import { PathLike } from "fs-extra";

declare module "pdf-merger-js" {
class PDFMerger {
constructor();
/**
* Resets the internal state of the document, to start again.
*
* @returns {void}
*/
reset(): void;
/**
* Add pages from a PDF document to the end of the merged document.
*
* @async
* @param {PdfInput} input - a pdf source
* @param {string | string[] | number | number[] | undefined | null} [pages]
* @returns {Promise<void>}
*/
add(inputFile: PdfInput, pages?: string | string[] | number | number[] | undefined | null): Promise<void>;
/**
* Save the merged PDF to the given path.
*
* @async
* @param {string | PathLike} fileName
* @returns {Promise<void>}
*/
save(fileName: string): Promise<void>;
/**
* Return the merged PDF as a Buffer.
*
* @async
* @returns {Promise<Buffer>}
*/
saveAsBuffer(): Promise<Buffer>;
/**
* Set the metadata of the merged PDF.
*
* @async
* @param {Metadata} metadata
* @returns {Promise<void>}
*/
setMetadata(metadata: Metadata): Promise<void>;
}
export default PDFMerger;
}
type PdfInput =
| Uint8Array
| ArrayBuffer
| Blob
| URL
| Buffer
| String
| PathLike
| string;

declare type PdfInput = Uint8Array | ArrayBuffer | Blob | URL | Buffer | String | PathLike | string;
interface Metadata {
producer?: string;
author?: string;
title?: string;
creator?: string;
}

declare interface Metadata {
producer?: string
author?: string
title?: string
creator?: string
declare class PDFMerger {
constructor();
/**
* Resets the internal state of the document, to start again.
*/
reset(): void;
/**
* Add pages from a PDF document to the end of the merged document.
*/
add(
inputFile: PdfInput,
pages?: string | string[] | number | number[] | undefined | null
): Promise<void>;
/**
* Save the merged PDF to the given path.
*/
save(fileName: string): Promise<void>;
/**
* Return the merged PDF as a Buffer.
*/
saveAsBuffer(): Promise<Buffer>;
/**
* Set the metadata of the merged PDF.
*/
setMetadata(metadata: Metadata): Promise<void>;
}

export default PDFMerger;