node-poppler 9.0.1 → 9.1.0

package/types/index.d.ts

@@ -1114,6 +1114,12 @@ export type PdfUniteOptions = {
      */
     printVersionInfo?: boolean | undefined;
 };
+export type PopplerExtraOptions = {
+    /**
+     * An `AbortSignal` that can be used to cancel the operation.
+     */
+    signal?: AbortSignal | undefined;
+};
 export class Poppler {
     /**
      * @param {string} [binPath] - Path of poppler-utils binaries.
@@ -1136,43 +1142,48 @@ export class Poppler {
      * @param {string} fileToAttach - Filepath of the attachment to be embedded into the PDF file.
      * @param {string} outputFile - Filepath of the file to output the results to.
      * @param {PdfAttachOptions} [options] - Options to pass to pdfattach binary.
+     * @param {PopplerExtraOptions} [extras] - Extra options.
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
-    pdfAttach(file: string, fileToAttach: string, outputFile: string, options?: PdfAttachOptions): Promise<string>;
+    pdfAttach(file: string, fileToAttach: string, outputFile: string, options?: PdfAttachOptions, extras?: PopplerExtraOptions): Promise<string>;
     /**
      * @author Frazer Smith
      * @description Lists or extracts embedded files (attachments) from a PDF file.
      * @param {string} file - Filepath of the PDF file to read.
      * @param {PdfDetachOptions} [options] - Options to pass to pdfdetach binary.
+     * @param {PopplerExtraOptions} [extras] - Extra options.
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
-    pdfDetach(file: string, options?: PdfDetachOptions): Promise<string>;
+    pdfDetach(file: string, options?: PdfDetachOptions, extras?: PopplerExtraOptions): Promise<string>;
     /**
      * @author Frazer Smith
      * @description Lists the fonts used in a PDF file along with various information for each font.
      * @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
      * @param {PdfFontsOptions} [options] - Options to pass to pdffonts binary.
+     * @param {PopplerExtraOptions} [extras] - Extra options.
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
-    pdfFonts(file: (Buffer | string), options?: PdfFontsOptions): Promise<string>;
+    pdfFonts(file: (Buffer | string), options?: PdfFontsOptions, extras?: PopplerExtraOptions): Promise<string>;
     /**
      * @author Frazer Smith
      * @description Saves images from a PDF file as PPM, PBM, PNG, TIFF, JPEG, JPEG2000, or JBIG2 files.
      * @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
      * @param {string} [outputPrefix] - Filename prefix of output files.
      * @param {PdfImagesOptions} [options] - Options to pass to pdfimages binary.
+     * @param {PopplerExtraOptions} [extras] - Extra options.
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
-    pdfImages(file: (Buffer | string), outputPrefix?: string, options?: PdfImagesOptions): Promise<string>;
+    pdfImages(file: (Buffer | string), outputPrefix?: string, options?: PdfImagesOptions, extras?: PopplerExtraOptions): Promise<string>;
     /**
      * @author Frazer Smith
      * @description Prints the contents of the `Info` dictionary from a PDF file.
      * @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
      * @param {PdfInfoOptions} [options] - Options to pass to pdfinfo binary.
+     * @param {PopplerExtraOptions} [extras] - Extra options.
      * @returns {Promise<object|string>} A promise that resolves with a stdout string or JSON object if
      * `options.printAsJson` is `true`, or rejects with an `Error` object.
      */
-    pdfInfo(file: (Buffer | string), options?: PdfInfoOptions): Promise<object | string>;
+    pdfInfo(file: (Buffer | string), options?: PdfInfoOptions, extras?: PopplerExtraOptions): Promise<object | string>;
     /**
      * @author Frazer Smith
      * @description Extracts single pages from a PDF file,
@@ -1183,9 +1194,10 @@ export class Poppler {
      * since %d is replaced by the page number.
      * As an example, `sample-%d.pdf` will produce `sample-1.pdf` for a single page document.
      * @param {PdfSeparateOptions} [options] - Options to pass to pdfseparate binary.
+     * @param {PopplerExtraOptions} [extras] - Extra options.
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
-    pdfSeparate(file: string, outputPattern: string, options?: PdfSeparateOptions): Promise<string>;
+    pdfSeparate(file: string, outputPattern: string, options?: PdfSeparateOptions, extras?: PopplerExtraOptions): Promise<string>;
     /**
      * @author Frazer Smith
      * @description Converts a PDF file to EPS/JPEG/PDF/PNG/PS/SVG/TIFF.
@@ -1198,9 +1210,10 @@ export class Poppler {
      *
      * If not set then the output filename will be derived from the PDF file name.
      * @param {PdfToCairoOptions} [options] - Options to pass to pdftocairo binary.
+     * @param {PopplerExtraOptions} [extras] - Extra options.
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
-    pdfToCairo(file: Buffer | string, outputFile?: string, options?: PdfToCairoOptions): Promise<string>;
+    pdfToCairo(file: Buffer | string, outputFile?: string, options?: PdfToCairoOptions, extras?: PopplerExtraOptions): Promise<string>;
     /**
      * @author Frazer Smith
      * @description Converts a PDF file to HTML.
@@ -1211,9 +1224,10 @@ export class Poppler {
      *
      * Required if `file` is a Buffer.
      * @param {PdfToHtmlOptions} [options] - Options to pass to pdftohtml binary.
+     * @param {PopplerExtraOptions} [extras] - Extra options.
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
-    pdfToHtml(file: (Buffer | string), outputFile?: string, options?: PdfToHtmlOptions): Promise<string>;
+    pdfToHtml(file: (Buffer | string), outputFile?: string, options?: PdfToHtmlOptions, extras?: PopplerExtraOptions): Promise<string>;
     /**
      * @author Frazer Smith
      * @description Converts a PDF file to colour image files in Portable Pixmap (PPM) format,
@@ -1222,9 +1236,10 @@ export class Poppler {
      * @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
      * @param {string} outputPath - Filepath to output the results to.
      * @param {PdfToPpmOptions} [options] - Options to pass to pdftoppm binary.
+     * @param {PopplerExtraOptions} [extras] - Extra options.
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
-    pdfToPpm(file: (Buffer | string), outputPath: string, options?: PdfToPpmOptions): Promise<string>;
+    pdfToPpm(file: (Buffer | string), outputPath: string, options?: PdfToPpmOptions, extras?: PopplerExtraOptions): Promise<string>;
     /**
      * @author Frazer Smith
      * @description Converts a PDF file to PostScript (PS).
@@ -1232,9 +1247,10 @@ export class Poppler {
      * @param {string} [outputFile] - Filepath of the file to output the results to.
      * If `undefined` then will write output to stdout.
      * @param {PdfToPsOptions} [options] - Options to pass to pdftops binary.
+     * @param {PopplerExtraOptions} [extras] - Extra options.
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
-    pdfToPs(file: (Buffer | string), outputFile?: string, options?: PdfToPsOptions): Promise<string>;
+    pdfToPs(file: (Buffer | string), outputFile?: string, options?: PdfToPsOptions, extras?: PopplerExtraOptions): Promise<string>;
     /**
      * @author Frazer Smith
      * @description Converts a PDF file to TXT.
@@ -1242,9 +1258,10 @@ export class Poppler {
      * @param {string} [outputFile] - Filepath of the file to output the results to.
      * If `undefined` then will write output to stdout.
      * @param {PdfToTextOptions} [options] - Options to pass to pdftotext binary.
+     * @param {PopplerExtraOptions} [extras] - Extra options.
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
-    pdfToText(file: (Buffer | string), outputFile?: string, options?: PdfToTextOptions): Promise<string>;
+    pdfToText(file: (Buffer | string), outputFile?: string, options?: PdfToTextOptions, extras?: PopplerExtraOptions): Promise<string>;
     /**
      * @author Frazer Smith
      * @description Merges several PDF files in order of their occurrence in the files array to
@@ -1253,8 +1270,9 @@ export class Poppler {
      * An entire directory of PDF files can be merged like so: `path/to/directory/*.pdf`.
      * @param {string} outputFile - Filepath of the file to output the resulting merged PDF to.
      * @param {PdfUniteOptions} [options] - Options to pass to pdfunite binary.
+     * @param {PopplerExtraOptions} [extras] - Extra options.
      * @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
      */
-    pdfUnite(files: string[], outputFile: string, options?: PdfUniteOptions): Promise<string>;
+    pdfUnite(files: string[], outputFile: string, options?: PdfUniteOptions, extras?: PopplerExtraOptions): Promise<string>;
     #private;
 }