node-poppler 8.0.3 → 8.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/index.js +1088 -1196
- package/types/index.d.ts +1122 -660
- package/types/index.d.ts.map +1 -0
package/types/index.d.ts
CHANGED
|
@@ -18,6 +18,1102 @@ export type OptionDetails = {
|
|
|
18
18
|
maxVersion?: string | undefined;
|
|
19
19
|
};
|
|
20
20
|
export type PopplerAcceptedOptions = Record<string, OptionDetails>;
|
|
21
|
+
export type PdfAttachOptions = {
|
|
22
|
+
/**
|
|
23
|
+
* Print copyright and version info.
|
|
24
|
+
*/
|
|
25
|
+
printVersionInfo?: boolean | undefined;
|
|
26
|
+
/**
|
|
27
|
+
* Replace embedded file with same name (if it exists).
|
|
28
|
+
*/
|
|
29
|
+
replace?: boolean | undefined;
|
|
30
|
+
};
|
|
31
|
+
export type PdfDetachOptions = {
|
|
32
|
+
/**
|
|
33
|
+
* List all of the embedded files in the PDF file.
|
|
34
|
+
* File names are converted to the text encoding specified by `options.outputEncoding`.
|
|
35
|
+
*/
|
|
36
|
+
listEmbedded?: boolean | undefined;
|
|
37
|
+
/**
|
|
38
|
+
* Sets the encoding to use for text output.
|
|
39
|
+
* This defaults to `UTF-8`.
|
|
40
|
+
*/
|
|
41
|
+
outputEncoding?: string | undefined;
|
|
42
|
+
/**
|
|
43
|
+
* Owner password (for encrypted files).
|
|
44
|
+
*/
|
|
45
|
+
ownerPassword?: string | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* Set the file name used when saving an embedded file with
|
|
48
|
+
* the save option enabled, or the directory if `options.saveall` is used.
|
|
49
|
+
*/
|
|
50
|
+
outputPath?: string | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* Print copyright and version info.
|
|
53
|
+
*/
|
|
54
|
+
printVersionInfo?: boolean | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* Save all of the embedded files. This uses the file
|
|
57
|
+
* names associated with the embedded files (as printed by `options.listEmbedded`).
|
|
58
|
+
* By default, the files are saved in the current directory; this can be changed
|
|
59
|
+
* with `options.outputPath`.
|
|
60
|
+
*/
|
|
61
|
+
saveAllFiles?: boolean | undefined;
|
|
62
|
+
/**
|
|
63
|
+
* Save the specified embedded file.
|
|
64
|
+
* By default, this uses the file name associated with the embedded file (as printed by
|
|
65
|
+
* `options.listEmbedded`); the file name can be changed with `options.outputPath`.
|
|
66
|
+
*/
|
|
67
|
+
saveFile?: string | undefined;
|
|
68
|
+
/**
|
|
69
|
+
* Save the specified embedded file.
|
|
70
|
+
* By default, this uses the file name associated with the embedded file (as printed by
|
|
71
|
+
* `options.listEmbedded`); the file name can be changed with `options.outputPath`.
|
|
72
|
+
*/
|
|
73
|
+
saveSpecificFile?: number | undefined;
|
|
74
|
+
/**
|
|
75
|
+
* User password (for encrypted files).
|
|
76
|
+
*/
|
|
77
|
+
userPassword?: string | undefined;
|
|
78
|
+
};
|
|
79
|
+
export type PdfFontsOptions = {
|
|
80
|
+
/**
|
|
81
|
+
* Specifies the first page to examine.
|
|
82
|
+
*/
|
|
83
|
+
firstPageToExamine?: number | undefined;
|
|
84
|
+
/**
|
|
85
|
+
* Specifies the last page to examine.
|
|
86
|
+
*/
|
|
87
|
+
lastPageToExamine?: number | undefined;
|
|
88
|
+
/**
|
|
89
|
+
* List the substitute fonts that poppler
|
|
90
|
+
* will use for non-embedded fonts.
|
|
91
|
+
*/
|
|
92
|
+
listSubstitutes?: boolean | undefined;
|
|
93
|
+
/**
|
|
94
|
+
* Owner password (for encrypted files).
|
|
95
|
+
*/
|
|
96
|
+
ownerPassword?: string | undefined;
|
|
97
|
+
/**
|
|
98
|
+
* Print copyright and version info.
|
|
99
|
+
*/
|
|
100
|
+
printVersionInfo?: boolean | undefined;
|
|
101
|
+
/**
|
|
102
|
+
* User password (for encrypted files).
|
|
103
|
+
*/
|
|
104
|
+
userPassword?: string | undefined;
|
|
105
|
+
};
|
|
106
|
+
export type PdfImagesOptions = {
|
|
107
|
+
/**
|
|
108
|
+
* Write JPEG, JPEG2000, JBIG2, and CCITT images in their native format.
|
|
109
|
+
* CMYK files are written as TIFF files. All other images are written as PNG files.
|
|
110
|
+
*/
|
|
111
|
+
allFiles?: boolean | undefined;
|
|
112
|
+
/**
|
|
113
|
+
* Generate CCITT images as CCITT files.
|
|
114
|
+
*/
|
|
115
|
+
ccittFile?: boolean | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* Specifies the first page to convert.
|
|
118
|
+
*/
|
|
119
|
+
firstPageToConvert?: number | undefined;
|
|
120
|
+
/**
|
|
121
|
+
* Specifies the last page to convert.
|
|
122
|
+
*/
|
|
123
|
+
lastPageToConvert?: number | undefined;
|
|
124
|
+
/**
|
|
125
|
+
* Generate JBIG2 images as JBIG2 files.
|
|
126
|
+
*/
|
|
127
|
+
jbig2File?: boolean | undefined;
|
|
128
|
+
/**
|
|
129
|
+
* Generate JPEG2000 images at JP2 files.
|
|
130
|
+
*/
|
|
131
|
+
jpeg2000File?: boolean | undefined;
|
|
132
|
+
/**
|
|
133
|
+
* Generate JPEG images as JPEG files.
|
|
134
|
+
*/
|
|
135
|
+
jpegFile?: boolean | undefined;
|
|
136
|
+
/**
|
|
137
|
+
* Instead of writing the images, list the
|
|
138
|
+
* images along with various information for each image.
|
|
139
|
+
* NOTE: Do not specify the outputPrefix with this option.
|
|
140
|
+
*/
|
|
141
|
+
list?: boolean | undefined;
|
|
142
|
+
/**
|
|
143
|
+
* Owner password (for encrypted files).
|
|
144
|
+
*/
|
|
145
|
+
ownerPassword?: string | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* Change the default output format to PNG.
|
|
148
|
+
*/
|
|
149
|
+
pngFile?: boolean | undefined;
|
|
150
|
+
/**
|
|
151
|
+
* Print copyright and version info.
|
|
152
|
+
*/
|
|
153
|
+
printVersionInfo?: boolean | undefined;
|
|
154
|
+
/**
|
|
155
|
+
* Change the default output format to TIFF.
|
|
156
|
+
*/
|
|
157
|
+
tiffFile?: boolean | undefined;
|
|
158
|
+
/**
|
|
159
|
+
* Specify the user password for the PDF file.
|
|
160
|
+
*/
|
|
161
|
+
userPassword?: string | undefined;
|
|
162
|
+
};
|
|
163
|
+
export type PdfInfoOptions = {
|
|
164
|
+
/**
|
|
165
|
+
* First page to print.
|
|
166
|
+
*/
|
|
167
|
+
firstPageToConvert?: number | undefined;
|
|
168
|
+
/**
|
|
169
|
+
* Last page to print.
|
|
170
|
+
*/
|
|
171
|
+
lastPageToConvert?: number | undefined;
|
|
172
|
+
/**
|
|
173
|
+
* List the available encodings.
|
|
174
|
+
*/
|
|
175
|
+
listEncodingOptions?: boolean | undefined;
|
|
176
|
+
/**
|
|
177
|
+
* Sets the encoding to use for text output.
|
|
178
|
+
* This defaults to `UTF-8`.
|
|
179
|
+
*/
|
|
180
|
+
outputEncoding?: string | undefined;
|
|
181
|
+
/**
|
|
182
|
+
* Owner password (for encrypted files).
|
|
183
|
+
*/
|
|
184
|
+
ownerPassword?: string | undefined;
|
|
185
|
+
/**
|
|
186
|
+
* Print result as a JSON object.
|
|
187
|
+
*/
|
|
188
|
+
printAsJson?: boolean | undefined;
|
|
189
|
+
/**
|
|
190
|
+
* Prints the page box bounding boxes:
|
|
191
|
+
* MediaBox, CropBox, BleedBox, TrimBox, and ArtBox.
|
|
192
|
+
*/
|
|
193
|
+
printBoundingBoxes?: boolean | undefined;
|
|
194
|
+
/**
|
|
195
|
+
* Prints the logical document structure
|
|
196
|
+
* of a Tagged-PDF file.
|
|
197
|
+
*/
|
|
198
|
+
printDocStruct?: boolean | undefined;
|
|
199
|
+
/**
|
|
200
|
+
* Print the textual content along with the
|
|
201
|
+
* document structure of a Tagged-PDF file. Note that extracting text this way might be slow
|
|
202
|
+
* for big PDF files.
|
|
203
|
+
*/
|
|
204
|
+
printDocStructText?: boolean | undefined;
|
|
205
|
+
/**
|
|
206
|
+
* Prints dates in ISO-8601 format (including the time zone).
|
|
207
|
+
*/
|
|
208
|
+
printIsoDates?: boolean | undefined;
|
|
209
|
+
/**
|
|
210
|
+
* Prints all JavaScript in the PDF file.
|
|
211
|
+
*/
|
|
212
|
+
printJS?: boolean | undefined;
|
|
213
|
+
/**
|
|
214
|
+
* Prints document-level metadata. (This is the `Metadata`
|
|
215
|
+
* stream from the PDF file's Catalog object).
|
|
216
|
+
*/
|
|
217
|
+
printMetadata?: boolean | undefined;
|
|
218
|
+
/**
|
|
219
|
+
* Print a list of all named destinations. If a page range
|
|
220
|
+
* is specified using the `options.firstPageToConvert` and `options.lastPageToConvert` options, only destinations
|
|
221
|
+
* in the page range are listed.
|
|
222
|
+
*/
|
|
223
|
+
printNamedDests?: boolean | undefined;
|
|
224
|
+
/**
|
|
225
|
+
* Prints the raw (undecoded) date strings, directly from the PDF file.
|
|
226
|
+
*/
|
|
227
|
+
printRawDates?: boolean | undefined;
|
|
228
|
+
/**
|
|
229
|
+
* Print all URLs in the PDF; only URLs referenced by PDF objects
|
|
230
|
+
* such as Link Annotations are listed, not URL strings in the text content.
|
|
231
|
+
*/
|
|
232
|
+
printUrls?: boolean | undefined;
|
|
233
|
+
/**
|
|
234
|
+
* Print copyright and version info.
|
|
235
|
+
*/
|
|
236
|
+
printVersionInfo?: boolean | undefined;
|
|
237
|
+
/**
|
|
238
|
+
* User password (for encrypted files).
|
|
239
|
+
*/
|
|
240
|
+
userPassword?: string | undefined;
|
|
241
|
+
};
|
|
242
|
+
export type PdfSeparateOptions = {
|
|
243
|
+
/**
|
|
244
|
+
* Specifies the first page to extract.
|
|
245
|
+
* This defaults to page 1.
|
|
246
|
+
*/
|
|
247
|
+
firstPageToExtract?: number | undefined;
|
|
248
|
+
/**
|
|
249
|
+
* Specifies the last page to extract.
|
|
250
|
+
* This defaults to the last page of the PDF file.
|
|
251
|
+
*/
|
|
252
|
+
lastPageToExtract?: number | undefined;
|
|
253
|
+
/**
|
|
254
|
+
* Print copyright and version info.
|
|
255
|
+
*/
|
|
256
|
+
printVersionInfo?: boolean | undefined;
|
|
257
|
+
};
|
|
258
|
+
export type PdfToCairoOptions = {
|
|
259
|
+
/**
|
|
260
|
+
* Set the cairo
|
|
261
|
+
* antialias option used for text and drawing in image files (or rasterized regions in vector output).
|
|
262
|
+
*/
|
|
263
|
+
antialias?: "best" | "default" | "fast" | "good" | "gray" | "none" | "subpixel" | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* Uses the crop box rather than media box when
|
|
266
|
+
* generating the files (PNG/JPEG/TIFF only).
|
|
267
|
+
*/
|
|
268
|
+
cropBox?: boolean | undefined;
|
|
269
|
+
/**
|
|
270
|
+
* Specifies the height of crop area in pixels
|
|
271
|
+
* (image output) or points (vector output).
|
|
272
|
+
*/
|
|
273
|
+
cropHeight?: number | undefined;
|
|
274
|
+
/**
|
|
275
|
+
* Specifies the size of crop square in pixels
|
|
276
|
+
* (image output) or points (vector output).
|
|
277
|
+
*/
|
|
278
|
+
cropSize?: number | undefined;
|
|
279
|
+
/**
|
|
280
|
+
* Specifies the width of crop area in pixels
|
|
281
|
+
* (image output) or points (vector output).
|
|
282
|
+
*/
|
|
283
|
+
cropWidth?: number | undefined;
|
|
284
|
+
/**
|
|
285
|
+
* Specifies the x-coordinate of the crop area top left
|
|
286
|
+
* corner in pixels (image output) or points (vector output).
|
|
287
|
+
*/
|
|
288
|
+
cropXAxis?: number | undefined;
|
|
289
|
+
/**
|
|
290
|
+
* Specifies the y-coordinate of the crop area top left
|
|
291
|
+
* corner in pixels (image output) or points (vector output).
|
|
292
|
+
*/
|
|
293
|
+
cropYAxis?: number | undefined;
|
|
294
|
+
/**
|
|
295
|
+
* Adds the %%IncludeFeature: *Duplex DuplexNoTumble DSC
|
|
296
|
+
* comment to the PostScript file (PS only). This tells the print manager to enable duplexing.
|
|
297
|
+
*/
|
|
298
|
+
duplex?: boolean | undefined;
|
|
299
|
+
/**
|
|
300
|
+
* Generate an EPS file. An EPS file contains a single image,
|
|
301
|
+
* so if you use this option with a multi-page PDF file, you must use `options.firstPageToConvert` and
|
|
302
|
+
* `options.lastPageToConvert` to specify a single page.
|
|
303
|
+
* The page size options (originalPageSizes, paperSize, paperWidth, paperHeight) can not be used
|
|
304
|
+
* with this option.
|
|
305
|
+
*/
|
|
306
|
+
epsFile?: boolean | undefined;
|
|
307
|
+
/**
|
|
308
|
+
* Generates only the even numbered pages.
|
|
309
|
+
*/
|
|
310
|
+
evenPagesOnly?: boolean | undefined;
|
|
311
|
+
/**
|
|
312
|
+
* Expand PDF pages smaller than the paper to fill the
|
|
313
|
+
* paper (PS,PDF,SVG only). By default, these pages are not scaled.
|
|
314
|
+
*/
|
|
315
|
+
fillPage?: boolean | undefined;
|
|
316
|
+
/**
|
|
317
|
+
* Specifies the first page to convert.
|
|
318
|
+
*/
|
|
319
|
+
firstPageToConvert?: number | undefined;
|
|
320
|
+
/**
|
|
321
|
+
* Generate grayscale file (PNG, JPEG, and TIFF only).
|
|
322
|
+
*/
|
|
323
|
+
grayscaleFile?: boolean | undefined;
|
|
324
|
+
/**
|
|
325
|
+
* Use the specified ICC file as the output profile
|
|
326
|
+
* (PNG only). The profile will be embedded in the PNG file.
|
|
327
|
+
*/
|
|
328
|
+
iccFile?: string | undefined;
|
|
329
|
+
/**
|
|
330
|
+
* Generate JPEG file(s).
|
|
331
|
+
*/
|
|
332
|
+
jpegFile?: boolean | undefined;
|
|
333
|
+
/**
|
|
334
|
+
* When used with `options.jpegFile`, this option can
|
|
335
|
+
* be used to control the JPEG compression parameters. It takes a string of the form
|
|
336
|
+
* `"<opt>=<val>[,<opt>=<val>]"`. Currently available options are:
|
|
337
|
+
* - `quality` Selects the JPEG quality value. The value must be an integer between 0 and 100.
|
|
338
|
+
* - `progressive` Select progressive JPEG output. The possible values are "y", "n", indicating
|
|
339
|
+
* progressive (yes) or non-progressive (no), respectively.
|
|
340
|
+
* - `optimize` Sets whether to compute optimal Huffman coding tables for the JPEG output, which
|
|
341
|
+
* will create smaller files but make an extra pass over the data. The value must be "y" or "n",
|
|
342
|
+
* with "y" performing optimization, otherwise the default Huffman tables are used.
|
|
343
|
+
*
|
|
344
|
+
* Example: `"quality=95,optimize=y"`.
|
|
345
|
+
*/
|
|
346
|
+
jpegOptions?: string | undefined;
|
|
347
|
+
/**
|
|
348
|
+
* Specifies the last page to convert.
|
|
349
|
+
*/
|
|
350
|
+
lastPageToConvert?: number | undefined;
|
|
351
|
+
/**
|
|
352
|
+
* Generate monochrome file (PNG and TIFF only).
|
|
353
|
+
*/
|
|
354
|
+
monochromeFile?: boolean | undefined;
|
|
355
|
+
/**
|
|
356
|
+
* By default, PDF pages smaller than the paper
|
|
357
|
+
* (after any scaling) are centered on the paper. This option causes them to be aligned to
|
|
358
|
+
* the lower-left corner of the paper instead (PS,PDF,SVG only).
|
|
359
|
+
*/
|
|
360
|
+
noCenter?: boolean | undefined;
|
|
361
|
+
/**
|
|
362
|
+
* By default, printing output is cropped to the CropBox
|
|
363
|
+
* specified in the PDF file. This option disables cropping (PS, PDF, SVG only).
|
|
364
|
+
*/
|
|
365
|
+
noCrop?: boolean | undefined;
|
|
366
|
+
/**
|
|
367
|
+
* Do not scale PDF pages which are larger than the paper
|
|
368
|
+
* (PS,PDF,SVG only). By default, pages larger than the paper are shrunk to fit.
|
|
369
|
+
*/
|
|
370
|
+
noShrink?: boolean | undefined;
|
|
371
|
+
/**
|
|
372
|
+
* Generates only the odd numbered pages.
|
|
373
|
+
*/
|
|
374
|
+
oddPagesOnly?: boolean | undefined;
|
|
375
|
+
/**
|
|
376
|
+
* Set the paper size of each page to match
|
|
377
|
+
* the size specified in the PDF file.
|
|
378
|
+
*/
|
|
379
|
+
originalPageSizes?: boolean | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* Specify the owner password for the PDF file.
|
|
382
|
+
* Providing this will bypass all security restrictions.
|
|
383
|
+
*/
|
|
384
|
+
ownerPassword?: string | undefined;
|
|
385
|
+
/**
|
|
386
|
+
* Set the paper height, in points (PS, PDF, SVG only).
|
|
387
|
+
*/
|
|
388
|
+
paperHeight?: number | undefined;
|
|
389
|
+
/**
|
|
390
|
+
* Set the paper size to one of `A3`, `A4`,
|
|
391
|
+
* `legal`, or `letter` (PS,PDF,SVG only). This can also be set to `match`, which will set the paper size
|
|
392
|
+
* of each page to match the size specified in the PDF file. If none of the paperSize,
|
|
393
|
+
* paperWidth, or paperHeight options are specified the default is to match the paper size.
|
|
394
|
+
*/
|
|
395
|
+
paperSize?: "A3" | "A4" | "legal" | "letter" | "match" | undefined;
|
|
396
|
+
/**
|
|
397
|
+
* Set the paper width, in points (PS,PDF,SVG only).
|
|
398
|
+
*/
|
|
399
|
+
paperWidth?: number | undefined;
|
|
400
|
+
/**
|
|
401
|
+
* Generate PDF file.
|
|
402
|
+
*/
|
|
403
|
+
pdfFile?: boolean | undefined;
|
|
404
|
+
/**
|
|
405
|
+
* Generate PNG file(s).
|
|
406
|
+
*/
|
|
407
|
+
pngFile?: boolean | undefined;
|
|
408
|
+
/**
|
|
409
|
+
* Print copyright and version information.
|
|
410
|
+
*/
|
|
411
|
+
printVersionInfo?: boolean | undefined;
|
|
412
|
+
/**
|
|
413
|
+
* If the input file contains structural information
|
|
414
|
+
* about the document's content, write this information to the output file (PDF only).
|
|
415
|
+
*/
|
|
416
|
+
printDocStruct?: boolean | undefined;
|
|
417
|
+
/**
|
|
418
|
+
* Generate PS file.
|
|
419
|
+
*/
|
|
420
|
+
psFile?: boolean | undefined;
|
|
421
|
+
/**
|
|
422
|
+
* Generate Level 2 PostScript (PS only).
|
|
423
|
+
*/
|
|
424
|
+
psLevel2?: boolean | undefined;
|
|
425
|
+
/**
|
|
426
|
+
* Generate Level 3 PostScript (PS only). This enables all
|
|
427
|
+
* Level 2 features plus shading patterns and masked images. This is the default setting.
|
|
428
|
+
*/
|
|
429
|
+
psLevel3?: boolean | undefined;
|
|
430
|
+
/**
|
|
431
|
+
* Do not print any messages or errors.
|
|
432
|
+
*/
|
|
433
|
+
quiet?: boolean | undefined;
|
|
434
|
+
/**
|
|
435
|
+
* Specifies the X resolution, in pixels per inch of
|
|
436
|
+
* image files (or rasterized regions in vector output). The default is 150 PPI.
|
|
437
|
+
*/
|
|
438
|
+
resolutionXAxis?: number | undefined;
|
|
439
|
+
/**
|
|
440
|
+
* Specifies the X and Y resolution, in pixels per
|
|
441
|
+
* inch of image files (or rasterized regions in vector output). The default is 150 PPI.
|
|
442
|
+
*/
|
|
443
|
+
resolutionXYAxis?: number | undefined;
|
|
444
|
+
/**
|
|
445
|
+
* Specifies the Y resolution, in pixels per inch of
|
|
446
|
+
* image files (or rasterized regions in vector output). The default is 150 PPI.
|
|
447
|
+
*/
|
|
448
|
+
resolutionYAxis?: number | undefined;
|
|
449
|
+
/**
|
|
450
|
+
* Scales the long side of each page (width for landscape
|
|
451
|
+
* pages, height for portrait pages) to fit in scale-to pixels. The size of the short side will
|
|
452
|
+
* be determined by the aspect ratio of the page (PNG/JPEG/TIFF only).
|
|
453
|
+
*/
|
|
454
|
+
scalePageTo?: number | undefined;
|
|
455
|
+
/**
|
|
456
|
+
* Scales each page horizontally to fit in scale-to-x
|
|
457
|
+
* pixels. If scale-to-y is set to -1, the vertical size will determined by the aspect ratio of
|
|
458
|
+
* the page (PNG/JPEG/TIFF only).
|
|
459
|
+
*/
|
|
460
|
+
scalePageToXAxis?: number | undefined;
|
|
461
|
+
/**
|
|
462
|
+
* Scales each page vertically to fit in scale-to-y
|
|
463
|
+
* pixels. If scale-to-x is set to -1, the horizontal size will determined by the aspect ratio of
|
|
464
|
+
* the page (PNG/JPEG/TIFF only).
|
|
465
|
+
*/
|
|
466
|
+
scalePageToYAxis?: number | undefined;
|
|
467
|
+
/**
|
|
468
|
+
* Writes only the first page and does not add digits.
|
|
469
|
+
* Can only be used with `options.jpegFile`, `options.pngFile`, and `options.tiffFile`.
|
|
470
|
+
*/
|
|
471
|
+
singleFile?: boolean | undefined;
|
|
472
|
+
/**
|
|
473
|
+
* Generate SVG (Scalable Vector Graphics) file.
|
|
474
|
+
*/
|
|
475
|
+
svgFile?: boolean | undefined;
|
|
476
|
+
/**
|
|
477
|
+
* Set TIFF compression.
|
|
478
|
+
*/
|
|
479
|
+
tiffCompression?: "none" | "deflate" | "jpeg" | "lzw" | "packbits" | undefined;
|
|
480
|
+
/**
|
|
481
|
+
* Generate TIFF file(s).
|
|
482
|
+
*/
|
|
483
|
+
tiffFile?: boolean | undefined;
|
|
484
|
+
/**
|
|
485
|
+
* Use a transparent page color
|
|
486
|
+
* instead of white (PNG and TIFF only).
|
|
487
|
+
*/
|
|
488
|
+
transparentPageColor?: boolean | undefined;
|
|
489
|
+
/**
|
|
490
|
+
* Specify the user password for the PDF file.
|
|
491
|
+
*/
|
|
492
|
+
userPassword?: string | undefined;
|
|
493
|
+
};
|
|
494
|
+
export type PdfToHtmlOptions = {
|
|
495
|
+
/**
|
|
496
|
+
* Generate complex output.
|
|
497
|
+
*/
|
|
498
|
+
complexOutput?: boolean | undefined;
|
|
499
|
+
/**
|
|
500
|
+
* Use data URLs instead of external images in HTML.
|
|
501
|
+
*/
|
|
502
|
+
dataUrls?: boolean | undefined;
|
|
503
|
+
/**
|
|
504
|
+
* Exchange .pdf links with .html.
|
|
505
|
+
*/
|
|
506
|
+
exchangePdfLinks?: boolean | undefined;
|
|
507
|
+
/**
|
|
508
|
+
* Force hidden text extraction.
|
|
509
|
+
*/
|
|
510
|
+
extractHidden?: boolean | undefined;
|
|
511
|
+
/**
|
|
512
|
+
* First page to print.
|
|
513
|
+
*/
|
|
514
|
+
firstPageToConvert?: number | undefined;
|
|
515
|
+
/**
|
|
516
|
+
* Outputs the font name without any substitutions.
|
|
517
|
+
*/
|
|
518
|
+
fontFullName?: boolean | undefined;
|
|
519
|
+
/**
|
|
520
|
+
* Ignore images.
|
|
521
|
+
*/
|
|
522
|
+
ignoreImages?: boolean | undefined;
|
|
523
|
+
/**
|
|
524
|
+
* Image file format for Splash output (JPG or PNG).
|
|
525
|
+
* If complexOutput is selected, but imageFormat is not specified, PNG will be assumed.
|
|
526
|
+
*/
|
|
527
|
+
imageFormat?: "JPG" | "PNG" | undefined;
|
|
528
|
+
/**
|
|
529
|
+
* Last page to print.
|
|
530
|
+
*/
|
|
531
|
+
lastPageToConvert?: number | undefined;
|
|
532
|
+
/**
|
|
533
|
+
* Override document DRM settings.
|
|
534
|
+
*/
|
|
535
|
+
noDrm?: boolean | undefined;
|
|
536
|
+
/**
|
|
537
|
+
* Generate no frames. Not supported in complex output mode.
|
|
538
|
+
*/
|
|
539
|
+
noFrames?: boolean | undefined;
|
|
540
|
+
/**
|
|
541
|
+
* Do not merge paragraphs.
|
|
542
|
+
*/
|
|
543
|
+
noMergeParagraph?: boolean | undefined;
|
|
544
|
+
/**
|
|
545
|
+
* Do not round coordinates
|
|
546
|
+
* (with XML output only).
|
|
547
|
+
*/
|
|
548
|
+
noRoundedCoordinates?: boolean | undefined;
|
|
549
|
+
/**
|
|
550
|
+
* Sets the encoding to use for text output.
|
|
551
|
+
* This defaults to `UTF-8`.
|
|
552
|
+
*/
|
|
553
|
+
outputEncoding?: string | undefined;
|
|
554
|
+
/**
|
|
555
|
+
* Owner password (for encrypted files).
|
|
556
|
+
*/
|
|
557
|
+
ownerPassword?: string | undefined;
|
|
558
|
+
/**
|
|
559
|
+
* Print copyright and version info.
|
|
560
|
+
*/
|
|
561
|
+
printVersionInfo?: boolean | undefined;
|
|
562
|
+
/**
|
|
563
|
+
* Do not print any messages or errors.
|
|
564
|
+
*/
|
|
565
|
+
quiet?: boolean | undefined;
|
|
566
|
+
/**
|
|
567
|
+
* Generate single HTML that includes all pages.
|
|
568
|
+
*/
|
|
569
|
+
singlePage?: boolean | undefined;
|
|
570
|
+
/**
|
|
571
|
+
* Use standard output.
|
|
572
|
+
*/
|
|
573
|
+
stdout?: boolean | undefined;
|
|
574
|
+
/**
|
|
575
|
+
* User password (for encrypted files).
|
|
576
|
+
*/
|
|
577
|
+
userPassword?: string | undefined;
|
|
578
|
+
/**
|
|
579
|
+
* Adjust the word break threshold percent.
|
|
580
|
+
* Default is 10. Word break occurs when distance between two adjacent characters is greater
|
|
581
|
+
* than this percent of character height.
|
|
582
|
+
*/
|
|
583
|
+
wordBreakThreshold?: number | undefined;
|
|
584
|
+
/**
|
|
585
|
+
* Output for XML post-processing.
|
|
586
|
+
*/
|
|
587
|
+
xmlOutput?: boolean | undefined;
|
|
588
|
+
/**
|
|
589
|
+
* Zoom the PDF document (default 1.5).
|
|
590
|
+
*/
|
|
591
|
+
zoom?: number | undefined;
|
|
592
|
+
};
|
|
593
|
+
export type PdfToPpmOptions = {
|
|
594
|
+
/**
|
|
595
|
+
* Enable or disable font anti-aliasing.
|
|
596
|
+
* This defaults to `yes`.
|
|
597
|
+
*/
|
|
598
|
+
antialiasFonts?: "no" | "yes" | undefined;
|
|
599
|
+
/**
|
|
600
|
+
* Enable or disable vector anti-aliasing.
|
|
601
|
+
* This defaults to `yes`.
|
|
602
|
+
*/
|
|
603
|
+
antialiasVectors?: "no" | "yes" | undefined;
|
|
604
|
+
/**
|
|
605
|
+
* Uses the crop box rather than media box when
|
|
606
|
+
* generating the files (PNG/JPEG/TIFF only).
|
|
607
|
+
*/
|
|
608
|
+
cropBox?: boolean | undefined;
|
|
609
|
+
/**
|
|
610
|
+
* Specifies the height of crop area in pixels
|
|
611
|
+
* (image output) or points (vector output).
|
|
612
|
+
*/
|
|
613
|
+
cropHeight?: number | undefined;
|
|
614
|
+
/**
|
|
615
|
+
* Specifies the size of crop square in pixels
|
|
616
|
+
* (image output) or points (vector output).
|
|
617
|
+
*/
|
|
618
|
+
cropSize?: number | undefined;
|
|
619
|
+
/**
|
|
620
|
+
* Specifies the width of crop area in pixels
|
|
621
|
+
* (image output) or points (vector output).
|
|
622
|
+
*/
|
|
623
|
+
cropWidth?: number | undefined;
|
|
624
|
+
/**
|
|
625
|
+
* Specifies the x-coordinate of the crop area top left
|
|
626
|
+
* corner in pixels (image output) or points (vector output).
|
|
627
|
+
*/
|
|
628
|
+
cropXAxis?: number | undefined;
|
|
629
|
+
/**
|
|
630
|
+
* Specifies the y-coordinate of the crop area top left
|
|
631
|
+
* corner in pixels (image output) or points (vector output).
|
|
632
|
+
*/
|
|
633
|
+
cropYAxis?: number | undefined;
|
|
634
|
+
/**
|
|
635
|
+
* If Poppler is compiled with colour management support, this option
|
|
636
|
+
* sets the DefaultCMYK color space to the ICC profile stored in the display profile file passed.
|
|
637
|
+
*/
|
|
638
|
+
defaultCmykProfile?: string | undefined;
|
|
639
|
+
/**
|
|
640
|
+
* If Poppler is compiled with colour management support, this option
|
|
641
|
+
* sets the DefaultGray color space to the ICC profile stored in the display profile file passed.
|
|
642
|
+
*/
|
|
643
|
+
defaultGrayProfile?: string | undefined;
|
|
644
|
+
/**
|
|
645
|
+
* If Poppler is compiled with colour management support, this option
|
|
646
|
+
* sets the DefaultRGB color space to the ICC profile stored in the display profile file passed.
|
|
647
|
+
*/
|
|
648
|
+
defaultRgbProfile?: string | undefined;
|
|
649
|
+
/**
|
|
650
|
+
* If Poppler is compiled with colour management support, this option
|
|
651
|
+
* sets the display profile to the ICC profile stored in the display profile file passed.
|
|
652
|
+
*/
|
|
653
|
+
displayProfile?: string | undefined;
|
|
654
|
+
/**
|
|
655
|
+
* Generates only the even numbered pages.
|
|
656
|
+
*/
|
|
657
|
+
evenPagesOnly?: boolean | undefined;
|
|
658
|
+
/**
|
|
659
|
+
* Specifies the first page to convert.
|
|
660
|
+
*/
|
|
661
|
+
firstPageToConvert?: number | undefined;
|
|
662
|
+
/**
|
|
663
|
+
* Enable or disable FreeType (a TrueType / Type 1 font rasterizer).
|
|
664
|
+
* This defaults to `yes`.
|
|
665
|
+
*/
|
|
666
|
+
freetype?: "no" | "yes" | undefined;
|
|
667
|
+
/**
|
|
668
|
+
* Force page number even if there is only one page.
|
|
669
|
+
*/
|
|
670
|
+
forcePageNumber?: boolean | undefined;
|
|
671
|
+
/**
|
|
672
|
+
* Generate grayscale PGM file (instead of a color PPM file).
|
|
673
|
+
*/
|
|
674
|
+
grayscaleFile?: boolean | undefined;
|
|
675
|
+
/**
|
|
676
|
+
* Hide annotations.
|
|
677
|
+
*/
|
|
678
|
+
hideAnnotations?: boolean | undefined;
|
|
679
|
+
/**
|
|
680
|
+
* Generate JPEG file instead a PPM file.
|
|
681
|
+
*/
|
|
682
|
+
jpegFile?: boolean | undefined;
|
|
683
|
+
/**
|
|
684
|
+
* Specifies the last page to convert.
|
|
685
|
+
*/
|
|
686
|
+
lastPageToConvert?: number | undefined;
|
|
687
|
+
/**
|
|
688
|
+
* Generate monochrome PBM file (instead of a color PPM file).
|
|
689
|
+
*/
|
|
690
|
+
monochromeFile?: boolean | undefined;
|
|
691
|
+
/**
|
|
692
|
+
* Generates only the odd numbered pages.
|
|
693
|
+
*/
|
|
694
|
+
oddPagesOnly?: boolean | undefined;
|
|
695
|
+
/**
|
|
696
|
+
* Specify the owner password for the PDF file.
|
|
697
|
+
* Providing this will bypass all security restrictions.
|
|
698
|
+
*/
|
|
699
|
+
ownerPassword?: string | undefined;
|
|
700
|
+
/**
|
|
701
|
+
* Generate PNG file instead a PPM file.
|
|
702
|
+
*/
|
|
703
|
+
pngFile?: boolean | undefined;
|
|
704
|
+
/**
|
|
705
|
+
* Print progress info as each page is generated.
|
|
706
|
+
* Three space-separated fields are printed to STDERR: the number of the current page, the number
|
|
707
|
+
* of the last page that will be generated, and the path to the file written to.
|
|
708
|
+
*/
|
|
709
|
+
printProgress?: boolean | undefined;
|
|
710
|
+
/**
|
|
711
|
+
* Print copyright and version information.
|
|
712
|
+
*/
|
|
713
|
+
printVersionInfo?: boolean | undefined;
|
|
714
|
+
/**
|
|
715
|
+
* Do not print any messages or errors.
|
|
716
|
+
*/
|
|
717
|
+
quiet?: boolean | undefined;
|
|
718
|
+
/**
|
|
719
|
+
* Specifies the X resolution, in pixels per inch of
|
|
720
|
+
* image files (or rasterized regions in vector output). The default is 150 PPI.
|
|
721
|
+
*/
|
|
722
|
+
resolutionXAxis?: number | undefined;
|
|
723
|
+
/**
|
|
724
|
+
* Specifies the X and Y resolution, in pixels per
|
|
725
|
+
* inch of image files (or rasterized regions in vector output). The default is 150 PPI.
|
|
726
|
+
*/
|
|
727
|
+
resolutionXYAxis?: number | undefined;
|
|
728
|
+
/**
|
|
729
|
+
* Specifies the Y resolution, in pixels per inch of
|
|
730
|
+
* image files (or rasterized regions in vector output). The default is 150 PPI.
|
|
731
|
+
*/
|
|
732
|
+
resolutionYAxis?: number | undefined;
|
|
733
|
+
/**
|
|
734
|
+
* Scales the long side of each page (width for landscape
|
|
735
|
+
* pages, height for portrait pages) to fit in scale-to pixels. The size of the short side will
|
|
736
|
+
* be determined by the aspect ratio of the page.
|
|
737
|
+
*/
|
|
738
|
+
scalePageTo?: number | undefined;
|
|
739
|
+
/**
|
|
740
|
+
* Scales each page horizontally to fit in scale-to-x
|
|
741
|
+
* pixels. If scale-to-y is set to -1, the vertical size will determined by the aspect ratio of
|
|
742
|
+
* the page.
|
|
743
|
+
*/
|
|
744
|
+
scalePageToXAxis?: number | undefined;
|
|
745
|
+
/**
|
|
746
|
+
* Scales each page vertically to fit in scale-to-y
|
|
747
|
+
* pixels. If scale-to-x is set to -1, the horizontal size will determined by the aspect ratio of
|
|
748
|
+
* the page.
|
|
749
|
+
*/
|
|
750
|
+
scalePageToYAxis?: number | undefined;
|
|
751
|
+
/**
|
|
752
|
+
* Specify single character separator between name and page number.
|
|
753
|
+
*/
|
|
754
|
+
separator?: string | undefined;
|
|
755
|
+
/**
|
|
756
|
+
* Writes only the first page and does not add digits.
|
|
757
|
+
*/
|
|
758
|
+
singleFile?: boolean | undefined;
|
|
759
|
+
/**
|
|
760
|
+
* Specifies the thin line mode. This defaults to `none`.
|
|
761
|
+
*/
|
|
762
|
+
thinLineMode?: "none" | "shape" | "solid" | undefined;
|
|
763
|
+
/**
|
|
764
|
+
* Set TIFF compression.
|
|
765
|
+
*/
|
|
766
|
+
tiffCompression?: "none" | "deflate" | "jpeg" | "lzw" | "packbits" | undefined;
|
|
767
|
+
/**
|
|
768
|
+
* Generate TIFF file instead a PPM file.
|
|
769
|
+
*/
|
|
770
|
+
tiffFile?: boolean | undefined;
|
|
771
|
+
/**
|
|
772
|
+
* Specify the user password for the PDF file.
|
|
773
|
+
*/
|
|
774
|
+
userPassword?: string | undefined;
|
|
775
|
+
};
|
|
776
|
+
export type PdfToPsOptions = {
|
|
777
|
+
/**
|
|
778
|
+
* Enable anti-aliasing on rasterization, accepts `no` or `yes`.
|
|
779
|
+
*/
|
|
780
|
+
antialias?: "no" | "yes" | undefined;
|
|
781
|
+
/**
|
|
782
|
+
* Write binary data in Level 1 PostScript. By default,
|
|
783
|
+
* pdftops writes hex-encoded data in Level 1 PostScript. Binary data is non-standard in Level 1
|
|
784
|
+
* PostScript but reduces the file size and can be useful when Level 1 PostScript is required
|
|
785
|
+
* only for its restricted use of PostScript operators.
|
|
786
|
+
*/
|
|
787
|
+
binary?: boolean | undefined;
|
|
788
|
+
/**
|
|
789
|
+
* If Poppler is compiled with colour management support, this option
|
|
790
|
+
* sets the DefaultCMYK color space to the ICC profile stored in the display profile file passed.
|
|
791
|
+
*/
|
|
792
|
+
defaultCmykProfile?: string | undefined;
|
|
793
|
+
/**
|
|
794
|
+
* If Poppler is compiled with colour management support, this option
|
|
795
|
+
* sets the DefaultGray color space to the ICC profile stored in the display profile file passed.
|
|
796
|
+
*/
|
|
797
|
+
defaultGrayProfile?: string | undefined;
|
|
798
|
+
/**
|
|
799
|
+
* If Poppler is compiled with colour management support, this option
|
|
800
|
+
* sets the DefaultRGB color space to the ICC profile stored in the display profile file passed.
|
|
801
|
+
*/
|
|
802
|
+
defaultRgbProfile?: string | undefined;
|
|
803
|
+
/**
|
|
804
|
+
* Set the Duplex pagedevice entry in the PostScript file.
|
|
805
|
+
* This tells duplex-capable printers to enable duplexing.
|
|
806
|
+
*/
|
|
807
|
+
duplex?: boolean | undefined;
|
|
808
|
+
/**
|
|
809
|
+
* Generate an EPS file. An EPS file contains a single image,
|
|
810
|
+
* so if you use this option with a multi-page PDF file, you must use `options.firstPageToConvert` and
|
|
811
|
+
* `options.lastPageToConvert` to specify a single page.
|
|
812
|
+
* The page size options (originalPageSizes, paperSize, paperWidth, paperHeight) can not be used
|
|
813
|
+
* with this option.
|
|
814
|
+
*/
|
|
815
|
+
epsFile?: boolean | undefined;
|
|
816
|
+
/**
|
|
817
|
+
* Expand PDF pages smaller than the paper to fill the
|
|
818
|
+
* paper. By default, these pages are not scaled.
|
|
819
|
+
*/
|
|
820
|
+
fillPage?: boolean | undefined;
|
|
821
|
+
/**
|
|
822
|
+
* Specifies the first page to convert.
|
|
823
|
+
*/
|
|
824
|
+
firstPageToConvert?: number | undefined;
|
|
825
|
+
/**
|
|
826
|
+
* Generate PostScript form which can be imported by software
|
|
827
|
+
* that understands forms.
|
|
828
|
+
* A form contains a single page, so if you use this option with a multi-page PDF file,
|
|
829
|
+
* you must use `options.firstPageToConvert` and `options.lastPageToConvert` to specify a single page.
|
|
830
|
+
* The `options.level1` option cannot be used with `options.form`.
|
|
831
|
+
* No more than one of the mode options (`options.epsFile`, `options.form`) may be given.
|
|
832
|
+
*/
|
|
833
|
+
form?: number | undefined;
|
|
834
|
+
/**
|
|
835
|
+
* Specifies the last page to convert.
|
|
836
|
+
*/
|
|
837
|
+
lastPageToConvert?: number | undefined;
|
|
838
|
+
/**
|
|
839
|
+
* Generate Level 1 PostScript. The resulting PostScript
|
|
840
|
+
* files will be significantly larger (if they contain images), but will print on Level 1 printers.
|
|
841
|
+
* This also converts all images to black and white.
|
|
842
|
+
*/
|
|
843
|
+
level1?: boolean | undefined;
|
|
844
|
+
/**
|
|
845
|
+
* Generate Level 1 separable PostScript.
|
|
846
|
+
* All colors are converted to CMYK. Images are written with separate stream data for the four components.
|
|
847
|
+
*/
|
|
848
|
+
level1Sep?: boolean | undefined;
|
|
849
|
+
/**
|
|
850
|
+
* Generate Level 2 PostScript.
|
|
851
|
+
* Level 2 supports color images and image compression. This is the default setting.
|
|
852
|
+
*/
|
|
853
|
+
level2?: boolean | undefined;
|
|
854
|
+
/**
|
|
855
|
+
* Generate Level 2 separable PostScript. All colors are
|
|
856
|
+
* converted to CMYK. The PostScript separation convention operators are used to handle custom (spot) colors.
|
|
857
|
+
*/
|
|
858
|
+
level2Sep?: boolean | undefined;
|
|
859
|
+
/**
|
|
860
|
+
* Generate Level 3 PostScript.
|
|
861
|
+
* This enables all Level 2 features plus CID font embedding.
|
|
862
|
+
*/
|
|
863
|
+
level3?: boolean | undefined;
|
|
864
|
+
/**
|
|
865
|
+
* Generate Level 3 separable PostScript.
|
|
866
|
+
* The separation handling is the same as for `options.level2Sep`.
|
|
867
|
+
*/
|
|
868
|
+
level3Sep?: boolean | undefined;
|
|
869
|
+
/**
|
|
870
|
+
* By default, PDF pages smaller than the paper
|
|
871
|
+
* (after any scaling) are centered on the paper. This option causes them to be aligned to
|
|
872
|
+
* the lower-left corner of the paper instead.
|
|
873
|
+
*/
|
|
874
|
+
noCenter?: boolean | undefined;
|
|
875
|
+
/**
|
|
876
|
+
* By default, printing output is cropped to the CropBox
|
|
877
|
+
* specified in the PDF file. This option disables cropping.
|
|
878
|
+
*/
|
|
879
|
+
noCrop?: boolean | undefined;
|
|
880
|
+
/**
|
|
881
|
+
* By default, any CID PostScript fonts which are
|
|
882
|
+
* embedded in the PDF file are copied into the PostScript file. This option disables that embedding.
|
|
883
|
+
* No attempt is made to substitute for non-embedded CID PostScript fonts.
|
|
884
|
+
*/
|
|
885
|
+
noEmbedCIDFonts?: boolean | undefined;
|
|
886
|
+
/**
|
|
887
|
+
* By default, any CID TrueType fonts which are
|
|
888
|
+
* embedded in the PDF file are copied into the PostScript file. This option disables that embedding.
|
|
889
|
+
* No attempt is made to substitute for non-embedded CID TrueType fonts.
|
|
890
|
+
*/
|
|
891
|
+
noEmbedCIDTrueTypeFonts?: boolean | undefined;
|
|
892
|
+
/**
|
|
893
|
+
* By default, any TrueType fonts which are embedded
|
|
894
|
+
* in the PDF file are copied into the PostScript file. This option causes pdfToPs to substitute base fonts instead.
|
|
895
|
+
* Embedded fonts make PostScript files larger, but may be necessary for readable output.
|
|
896
|
+
* Also, some PostScript interpreters do not have TrueType rasterizers.
|
|
897
|
+
*/
|
|
898
|
+
noEmbedTrueTypeFonts?: boolean | undefined;
|
|
899
|
+
/**
|
|
900
|
+
* By default, any Type 1 fonts which are embedded in the PDF file
|
|
901
|
+
* are copied into the PostScript file. This option causes pdfToPs to substitute base fonts instead.
|
|
902
|
+
* Embedded fonts make PostScript files larger, but may be necessary for readable output.
|
|
903
|
+
*/
|
|
904
|
+
noEmbedType1Fonts?: boolean | undefined;
|
|
905
|
+
/**
|
|
906
|
+
* Do not scale PDF pages which are larger than the paper.
|
|
907
|
+
* By default, pages larger than the paper are shrunk to fit.
|
|
908
|
+
*/
|
|
909
|
+
noShrink?: boolean | undefined;
|
|
910
|
+
/**
|
|
911
|
+
* Generate OPI comments for all images and forms which have OPI information.
|
|
912
|
+
*/
|
|
913
|
+
opi?: boolean | undefined;
|
|
914
|
+
/**
|
|
915
|
+
* By default, bitmap images in the PDF pass through to the
|
|
916
|
+
* output PostScript in their original color space, which produces predictable results.
|
|
917
|
+
* This option converts RGB and CMYK images into Gray images if every pixel of the image has equal components.
|
|
918
|
+
* This can fix problems when doing color separations of PDFs that contain embedded black and
|
|
919
|
+
* white images encoded as RGB.
|
|
920
|
+
*/
|
|
921
|
+
optimizecolorspace?: boolean | undefined;
|
|
922
|
+
/**
|
|
923
|
+
* Set the paper size of each page to match
|
|
924
|
+
* the size specified in the PDF file.
|
|
925
|
+
*/
|
|
926
|
+
originalPageSizes?: boolean | undefined;
|
|
927
|
+
/**
|
|
928
|
+
* Enable overprinting.
|
|
929
|
+
*/
|
|
930
|
+
overprint?: boolean | undefined;
|
|
931
|
+
/**
|
|
932
|
+
* Owner password (for encrypted files).
|
|
933
|
+
*/
|
|
934
|
+
ownerPassword?: string | undefined;
|
|
935
|
+
/**
|
|
936
|
+
* Set the paper height, in points.
|
|
937
|
+
*/
|
|
938
|
+
paperHeight?: number | undefined;
|
|
939
|
+
/**
|
|
940
|
+
* Set the paper size to one of `A3`, `A4`,
|
|
941
|
+
* `legal`, or `letter`. This can also be set to `match`, which will set the paper size
|
|
942
|
+
* of each page to match the size specified in the PDF file. If none of the paperSize,
|
|
943
|
+
* paperWidth, or paperHeight options are specified the default is to match the paper size.
|
|
944
|
+
*/
|
|
945
|
+
paperSize?: "A3" | "A4" | "legal" | "letter" | "match" | undefined;
|
|
946
|
+
/**
|
|
947
|
+
* Set the paper width, in points.
|
|
948
|
+
*/
|
|
949
|
+
paperWidth?: number | undefined;
|
|
950
|
+
/**
|
|
951
|
+
* By default, references to non-embedded 8-bit fonts
|
|
952
|
+
* in the PDF file are substituted with the closest `Helvetica`, `Times-Roman`, or `Courier` font.
|
|
953
|
+
* This option passes references to non-embedded fonts through to the PostScript file.
|
|
954
|
+
*/
|
|
955
|
+
passfonts?: boolean | undefined;
|
|
956
|
+
/**
|
|
957
|
+
* Preload images and forms.
|
|
958
|
+
*/
|
|
959
|
+
preload?: boolean | undefined;
|
|
960
|
+
/**
|
|
961
|
+
* Print copyright and version information.
|
|
962
|
+
*/
|
|
963
|
+
printVersionInfo?: boolean | undefined;
|
|
964
|
+
/**
|
|
965
|
+
* Sets the process color format as it is used
|
|
966
|
+
* during rasterization and transparency reduction.
|
|
967
|
+
*
|
|
968
|
+
* The default depends on the other settings: For `options.level1` the default is MONO8; for `options.level1Sep`,
|
|
969
|
+
* `options.level2Sep`, `options.level3Sep`, or `options.overprint` the default is CMYK8; in all other
|
|
970
|
+
* cases RGB8 is the default.
|
|
971
|
+
* If `option.processColorProfile` is set then `options.processColorFormat` is inferred from the specified ICC profile.
|
|
972
|
+
*/
|
|
973
|
+
processColorFormat?: "CMYK8" | "MONO8" | "RGB8" | undefined;
|
|
974
|
+
/**
|
|
975
|
+
* Sets the ICC profile that is assumed during
|
|
976
|
+
* rasterization and transparency reduction.
|
|
977
|
+
*/
|
|
978
|
+
processColorProfile?: string | undefined;
|
|
979
|
+
/**
|
|
980
|
+
* Do not print any messages or errors.
|
|
981
|
+
*/
|
|
982
|
+
quiet?: boolean | undefined;
|
|
983
|
+
/**
|
|
984
|
+
* By default, pdfToPs rasterizes pages as needed,
|
|
985
|
+
* for example, if they contain transparencies. To force rasterization, set `rasterize` to `always`.
|
|
986
|
+
* Use this to eliminate fonts.
|
|
987
|
+
* To prevent rasterization, set `rasterize` to `never`.
|
|
988
|
+
* This may produce files that display incorrectly.
|
|
989
|
+
*/
|
|
990
|
+
rasterize?: "always" | "never" | "whenneeded" | undefined;
|
|
991
|
+
/**
|
|
992
|
+
* Specifies the X and Y resolution, in pixels per
|
|
993
|
+
* inch of image files (or rasterized regions in vector output). The default is 300 PPI.
|
|
994
|
+
*/
|
|
995
|
+
resolutionXYAxis?: number | undefined;
|
|
996
|
+
/**
|
|
997
|
+
* User password (for encrypted files).
|
|
998
|
+
*/
|
|
999
|
+
userPassword?: string | undefined;
|
|
1000
|
+
};
|
|
1001
|
+
export type PdfToTextOptions = {
|
|
1002
|
+
/**
|
|
1003
|
+
* Generate an XHTML file containing bounding
|
|
1004
|
+
* box information for each word in the file.
|
|
1005
|
+
*/
|
|
1006
|
+
boundingBoxXhtml?: boolean | undefined;
|
|
1007
|
+
/**
|
|
1008
|
+
* Generate an XHTML file containing
|
|
1009
|
+
* bounding box information for each block, line, and word in the file.
|
|
1010
|
+
*/
|
|
1011
|
+
boundingBoxXhtmlLayout?: boolean | undefined;
|
|
1012
|
+
/**
|
|
1013
|
+
* Use the crop box rather than the media box with
|
|
1014
|
+
* `options.boundingBoxXhtml` and `options.boundingBoxXhtmlLayout`.
|
|
1015
|
+
*/
|
|
1016
|
+
cropBox?: boolean | undefined;
|
|
1017
|
+
/**
|
|
1018
|
+
* Specifies the height of crop area in pixels
|
|
1019
|
+
* (image output) or points (vector output).
|
|
1020
|
+
*/
|
|
1021
|
+
cropHeight?: number | undefined;
|
|
1022
|
+
/**
|
|
1023
|
+
* Specifies the width of crop area in pixels
|
|
1024
|
+
* (image output) or points (vector output).
|
|
1025
|
+
*/
|
|
1026
|
+
cropWidth?: number | undefined;
|
|
1027
|
+
/**
|
|
1028
|
+
* Specifies the x-coordinate of the crop area top left
|
|
1029
|
+
* corner in pixels (image output) or points (vector output).
|
|
1030
|
+
*/
|
|
1031
|
+
cropXAxis?: number | undefined;
|
|
1032
|
+
/**
|
|
1033
|
+
* Specifies the y-coordinate of the crop area top left
|
|
1034
|
+
* corner in pixels (image output) or points (vector output).
|
|
1035
|
+
*/
|
|
1036
|
+
cropYAxis?: number | undefined;
|
|
1037
|
+
/**
|
|
1038
|
+
* Sets the end-of-line convention to use for
|
|
1039
|
+
* text output: dos; mac; unix.
|
|
1040
|
+
*/
|
|
1041
|
+
eolConvention?: "dos" | "mac" | "unix" | undefined;
|
|
1042
|
+
/**
|
|
1043
|
+
* Specifies the first page to convert.
|
|
1044
|
+
*/
|
|
1045
|
+
firstPageToConvert?: number | undefined;
|
|
1046
|
+
/**
|
|
1047
|
+
* Assume fixed-pitch (or tabular) text, with the
|
|
1048
|
+
* specified character width (in points). This forces physical layout mode.
|
|
1049
|
+
*/
|
|
1050
|
+
fixedWidthLayout?: number | undefined;
|
|
1051
|
+
/**
|
|
1052
|
+
* Generate simple HTML file, including the
|
|
1053
|
+
* meta information. This simply wraps the text in `<pre>` and `</pre>` and prepends the meta headers.
|
|
1054
|
+
*/
|
|
1055
|
+
generateHtmlMetaFile?: boolean | undefined;
|
|
1056
|
+
/**
|
|
1057
|
+
* Generate a TSV file containing the bounding box
|
|
1058
|
+
* information for each block, line, and word in the file.
|
|
1059
|
+
*/
|
|
1060
|
+
generateTsvFile?: boolean | undefined;
|
|
1061
|
+
/**
|
|
1062
|
+
* Specifies the last page to convert.
|
|
1063
|
+
*/
|
|
1064
|
+
lastPageToConvert?: number | undefined;
|
|
1065
|
+
/**
|
|
1066
|
+
* List the available encodings.
|
|
1067
|
+
*/
|
|
1068
|
+
listEncodingOptions?: boolean | undefined;
|
|
1069
|
+
/**
|
|
1070
|
+
* Maintain (as best as possible) the original physical
|
|
1071
|
+
* layout of the text. The default is to undo physical layout (columns, hyphenation, etc.) and
|
|
1072
|
+
* output the text in reading order.
|
|
1073
|
+
*/
|
|
1074
|
+
maintainLayout?: boolean | undefined;
|
|
1075
|
+
/**
|
|
1076
|
+
* Discard diagonal text.
|
|
1077
|
+
*/
|
|
1078
|
+
noDiagonalText?: boolean | undefined;
|
|
1079
|
+
/**
|
|
1080
|
+
* Do not insert page breaks (form feed characters)
|
|
1081
|
+
* between pages.
|
|
1082
|
+
*/
|
|
1083
|
+
noPageBreaks?: boolean | undefined;
|
|
1084
|
+
/**
|
|
1085
|
+
* Sets the encoding to use for text output.
|
|
1086
|
+
* This defaults to `UTF-8`.
|
|
1087
|
+
*/
|
|
1088
|
+
outputEncoding?: string | undefined;
|
|
1089
|
+
/**
|
|
1090
|
+
* Owner password (for encrypted files).
|
|
1091
|
+
*/
|
|
1092
|
+
ownerPassword?: string | undefined;
|
|
1093
|
+
/**
|
|
1094
|
+
* Print copyright and version information.
|
|
1095
|
+
*/
|
|
1096
|
+
printVersionInfo?: boolean | undefined;
|
|
1097
|
+
/**
|
|
1098
|
+
* Do not print any messages or errors.
|
|
1099
|
+
*/
|
|
1100
|
+
quiet?: boolean | undefined;
|
|
1101
|
+
/**
|
|
1102
|
+
* Keep the text in content stream order. This is a
|
|
1103
|
+
* hack which often undoes column formatting, etc. Use of raw mode is no longer recommended.
|
|
1104
|
+
*/
|
|
1105
|
+
rawLayout?: boolean | undefined;
|
|
1106
|
+
/**
|
|
1107
|
+
* User password (for encrypted files).
|
|
1108
|
+
*/
|
|
1109
|
+
userPassword?: string | undefined;
|
|
1110
|
+
};
|
|
1111
|
+
export type PdfUniteOptions = {
|
|
1112
|
+
/**
|
|
1113
|
+
* Print copyright and version information.
|
|
1114
|
+
*/
|
|
1115
|
+
printVersionInfo?: boolean | undefined;
|
|
1116
|
+
};
|
|
21
1117
|
export class Poppler {
|
|
22
1118
|
/**
|
|
23
1119
|
* @param {string} [binPath] - Path of poppler-utils binaries.
|
|
@@ -25,6 +1121,7 @@ export class Poppler {
|
|
|
25
1121
|
* in the PATH environment variable and use that as the path for all binaries.
|
|
26
1122
|
* For `win32` the binaries are bundled with the package and will be used
|
|
27
1123
|
* if a local installation is not found.
|
|
1124
|
+
* @throws {Error} If the Poppler binaries cannot be found.
|
|
28
1125
|
*/
|
|
29
1126
|
constructor(binPath?: string);
|
|
30
1127
|
/**
|
|
@@ -38,166 +1135,44 @@ export class Poppler {
|
|
|
38
1135
|
* @param {string} file - Filepath of the PDF file to read.
|
|
39
1136
|
* @param {string} fileToAttach - Filepath of the attachment to be embedded into the PDF file.
|
|
40
1137
|
* @param {string} outputFile - Filepath of the file to output the results to.
|
|
41
|
-
* @param {
|
|
42
|
-
* @param {boolean} [options.printVersionInfo] - Print copyright and version info.
|
|
43
|
-
* @param {boolean} [options.replace] - Replace embedded file with same name (if it exists).
|
|
1138
|
+
* @param {PdfAttachOptions} [options] - Options to pass to pdfattach binary.
|
|
44
1139
|
* @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
|
|
45
1140
|
*/
|
|
46
|
-
pdfAttach(file: string, fileToAttach: string, outputFile: string, options?:
|
|
47
|
-
printVersionInfo?: boolean | undefined;
|
|
48
|
-
replace?: boolean | undefined;
|
|
49
|
-
}): Promise<string>;
|
|
1141
|
+
pdfAttach(file: string, fileToAttach: string, outputFile: string, options?: PdfAttachOptions): Promise<string>;
|
|
50
1142
|
/**
|
|
51
1143
|
* @author Frazer Smith
|
|
52
1144
|
* @description Lists or extracts embedded files (attachments) from a PDF file.
|
|
53
1145
|
* @param {string} file - Filepath of the PDF file to read.
|
|
54
|
-
* @param {
|
|
55
|
-
* @param {boolean} [options.listEmbedded] - List all of the embedded files in the PDF file.
|
|
56
|
-
* File names are converted to the text encoding specified by `options.outputEncoding`.
|
|
57
|
-
* @param {string} [options.outputEncoding] - Sets the encoding to use for text output.
|
|
58
|
-
* This defaults to `UTF-8`.
|
|
59
|
-
* @param {string} [options.ownerPassword] - Owner password (for encrypted files).
|
|
60
|
-
* @param {string} [options.outputPath] - Set the file name used when saving an embedded file with
|
|
61
|
-
* the save option enabled, or the directory if `options.saveall` is used.
|
|
62
|
-
* @param {boolean} [options.printVersionInfo] - Print copyright and version info.
|
|
63
|
-
* @param {boolean} [options.saveAllFiles] - Save all of the embedded files. This uses the file
|
|
64
|
-
* names associated with the embedded files (as printed by `options.listEmbedded`).
|
|
65
|
-
* By default, the files are saved in the current directory; this can be changed
|
|
66
|
-
* with `options.outputPath`.
|
|
67
|
-
* @param {string} [options.saveFile] - Save the specified embedded file.
|
|
68
|
-
* By default, this uses the file name associated with the embedded file (as printed by
|
|
69
|
-
* `options.listEmbedded`); the file name can be changed with `options.outputPath`.
|
|
70
|
-
* @param {number} [options.saveSpecificFile] - Save the specified embedded file.
|
|
71
|
-
* By default, this uses the file name associated with the embedded file (as printed by
|
|
72
|
-
* `options.listEmbedded`); the file name can be changed with `options.outputPath`.
|
|
73
|
-
* @param {string} [options.userPassword] - User password (for encrypted files).
|
|
1146
|
+
* @param {PdfDetachOptions} [options] - Options to pass to pdfdetach binary.
|
|
74
1147
|
* @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
|
|
75
1148
|
*/
|
|
76
|
-
pdfDetach(file: string, options?:
|
|
77
|
-
listEmbedded?: boolean | undefined;
|
|
78
|
-
outputEncoding?: string | undefined;
|
|
79
|
-
ownerPassword?: string | undefined;
|
|
80
|
-
outputPath?: string | undefined;
|
|
81
|
-
printVersionInfo?: boolean | undefined;
|
|
82
|
-
saveAllFiles?: boolean | undefined;
|
|
83
|
-
saveFile?: string | undefined;
|
|
84
|
-
saveSpecificFile?: number | undefined;
|
|
85
|
-
userPassword?: string | undefined;
|
|
86
|
-
}): Promise<string>;
|
|
1149
|
+
pdfDetach(file: string, options?: PdfDetachOptions): Promise<string>;
|
|
87
1150
|
/**
|
|
88
1151
|
* @author Frazer Smith
|
|
89
1152
|
* @description Lists the fonts used in a PDF file along with various information for each font.
|
|
90
1153
|
* @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
|
|
91
|
-
* @param {
|
|
92
|
-
* @param {number} [options.firstPageToExamine] - Specifies the first page to examine.
|
|
93
|
-
* @param {number} [options.lastPageToExamine] - Specifies the last page to examine.
|
|
94
|
-
* @param {boolean} [options.listSubstitutes] - List the substitute fonts that poppler
|
|
95
|
-
* will use for non-embedded fonts.
|
|
96
|
-
* @param {string} [options.ownerPassword] - Owner password (for encrypted files).
|
|
97
|
-
* @param {boolean} [options.printVersionInfo] - Print copyright and version info.
|
|
98
|
-
* @param {string} [options.userPassword] - User password (for encrypted files).
|
|
1154
|
+
* @param {PdfFontsOptions} [options] - Options to pass to pdffonts binary.
|
|
99
1155
|
* @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
|
|
100
1156
|
*/
|
|
101
|
-
pdfFonts(file: (Buffer | string), options?:
|
|
102
|
-
firstPageToExamine?: number | undefined;
|
|
103
|
-
lastPageToExamine?: number | undefined;
|
|
104
|
-
listSubstitutes?: boolean | undefined;
|
|
105
|
-
ownerPassword?: string | undefined;
|
|
106
|
-
printVersionInfo?: boolean | undefined;
|
|
107
|
-
userPassword?: string | undefined;
|
|
108
|
-
}): Promise<string>;
|
|
1157
|
+
pdfFonts(file: (Buffer | string), options?: PdfFontsOptions): Promise<string>;
|
|
109
1158
|
/**
|
|
110
1159
|
* @author Frazer Smith
|
|
111
1160
|
* @description Saves images from a PDF file as PPM, PBM, PNG, TIFF, JPEG, JPEG2000, or JBIG2 files.
|
|
112
1161
|
* @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
|
|
113
1162
|
* @param {string} [outputPrefix] - Filename prefix of output files.
|
|
114
|
-
* @param {
|
|
115
|
-
* @param {boolean} [options.allFiles] - Write JPEG, JPEG2000, JBIG2, and CCITT images in their native format.
|
|
116
|
-
* CMYK files are written as TIFF files. All other images are written as PNG files.
|
|
117
|
-
* @param {boolean} [options.ccittFile] - Generate CCITT images as CCITT files.
|
|
118
|
-
* @param {number} [options.firstPageToConvert] - Specifies the first page to convert.
|
|
119
|
-
* @param {number} [options.lastPageToConvert] - Specifies the last page to convert.
|
|
120
|
-
* @param {boolean} [options.jbig2File] - Generate JBIG2 images as JBIG2 files.
|
|
121
|
-
* @param {boolean} [options.jpeg2000File] - Generate JPEG2000 images at JP2 files.
|
|
122
|
-
* @param {boolean} [options.jpegFile] - Generate JPEG images as JPEG files.
|
|
123
|
-
* @param {boolean} [options.list] - Instead of writing the images, list the
|
|
124
|
-
* images along with various information for each image.
|
|
125
|
-
* NOTE: Do not specify the outputPrefix with this option.
|
|
126
|
-
* @param {string} [options.ownerPassword] - Owner password (for encrypted files).
|
|
127
|
-
* @param {boolean} [options.pngFile] - Change the default output format to PNG.
|
|
128
|
-
* @param {boolean} [options.printVersionInfo] - Print copyright and version info.
|
|
129
|
-
* @param {boolean} [options.tiffFile] - Change the default output format to TIFF.
|
|
130
|
-
* @param {string} [options.userPassword] - Specify the user password for the PDF file.
|
|
1163
|
+
* @param {PdfImagesOptions} [options] - Options to pass to pdfimages binary.
|
|
131
1164
|
* @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
|
|
132
1165
|
*/
|
|
133
|
-
pdfImages(file: (Buffer | string), outputPrefix?: string, options?:
|
|
134
|
-
allFiles?: boolean | undefined;
|
|
135
|
-
ccittFile?: boolean | undefined;
|
|
136
|
-
firstPageToConvert?: number | undefined;
|
|
137
|
-
lastPageToConvert?: number | undefined;
|
|
138
|
-
jbig2File?: boolean | undefined;
|
|
139
|
-
jpeg2000File?: boolean | undefined;
|
|
140
|
-
jpegFile?: boolean | undefined;
|
|
141
|
-
list?: boolean | undefined;
|
|
142
|
-
ownerPassword?: string | undefined;
|
|
143
|
-
pngFile?: boolean | undefined;
|
|
144
|
-
printVersionInfo?: boolean | undefined;
|
|
145
|
-
tiffFile?: boolean | undefined;
|
|
146
|
-
userPassword?: string | undefined;
|
|
147
|
-
}): Promise<string>;
|
|
1166
|
+
pdfImages(file: (Buffer | string), outputPrefix?: string, options?: PdfImagesOptions): Promise<string>;
|
|
148
1167
|
/**
|
|
149
1168
|
* @author Frazer Smith
|
|
150
1169
|
* @description Prints the contents of the `Info` dictionary from a PDF file.
|
|
151
1170
|
* @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
|
|
152
|
-
* @param {
|
|
153
|
-
* @param {number} [options.firstPageToConvert] - First page to print.
|
|
154
|
-
* @param {number} [options.lastPageToConvert] - Last page to print.
|
|
155
|
-
* @param {boolean} [options.listEncodingOptions] - List the available encodings.
|
|
156
|
-
* @param {string} [options.outputEncoding] - Sets the encoding to use for text output.
|
|
157
|
-
* This defaults to `UTF-8`.
|
|
158
|
-
* @param {string} [options.ownerPassword] - Owner password (for encrypted files).
|
|
159
|
-
* @param {boolean} [options.printAsJson] - Print result as a JSON object.
|
|
160
|
-
* @param {boolean} [options.printBoundingBoxes] - Prints the page box bounding boxes:
|
|
161
|
-
* MediaBox, CropBox, BleedBox, TrimBox, and ArtBox.
|
|
162
|
-
* @param {boolean} [options.printDocStruct] - Prints the logical document structure
|
|
163
|
-
* of a Tagged-PDF file.
|
|
164
|
-
* @param {boolean} [options.printDocStructText] - Print the textual content along with the
|
|
165
|
-
* document structure of a Tagged-PDF file. Note that extracting text this way might be slow
|
|
166
|
-
* for big PDF files.
|
|
167
|
-
* @param {boolean} [options.printIsoDates] - Prints dates in ISO-8601 format (including the time zone).
|
|
168
|
-
* @param {boolean} [options.printJS] - Prints all JavaScript in the PDF file.
|
|
169
|
-
* @param {boolean} [options.printMetadata] - Prints document-level metadata. (This is the `Metadata`
|
|
170
|
-
* stream from the PDF file's Catalog object).
|
|
171
|
-
* @param {boolean} [options.printNamedDests] - Print a list of all named destinations. If a page range
|
|
172
|
-
* is specified using the `options.firstPageToConvert` and `options.lastPageToConvert` options, only destinations
|
|
173
|
-
* in the page range are listed.
|
|
174
|
-
* @param {boolean} [options.printRawDates] - Prints the raw (undecoded) date strings, directly from the PDF file.
|
|
175
|
-
* @param {boolean} [options.printUrls] - Print all URLs in the PDF; only URLs referenced by PDF objects
|
|
176
|
-
* such as Link Annotations are listed, not URL strings in the text content.
|
|
177
|
-
* @param {boolean} [options.printVersionInfo] - Print copyright and version info.
|
|
178
|
-
* @param {string} [options.userPassword] - User password (for encrypted files).
|
|
1171
|
+
* @param {PdfInfoOptions} [options] - Options to pass to pdfinfo binary.
|
|
179
1172
|
* @returns {Promise<object|string>} A promise that resolves with a stdout string or JSON object if
|
|
180
1173
|
* `options.printAsJson` is `true`, or rejects with an `Error` object.
|
|
181
1174
|
*/
|
|
182
|
-
pdfInfo(file: (Buffer | string), options?:
|
|
183
|
-
firstPageToConvert?: number | undefined;
|
|
184
|
-
lastPageToConvert?: number | undefined;
|
|
185
|
-
listEncodingOptions?: boolean | undefined;
|
|
186
|
-
outputEncoding?: string | undefined;
|
|
187
|
-
ownerPassword?: string | undefined;
|
|
188
|
-
printAsJson?: boolean | undefined;
|
|
189
|
-
printBoundingBoxes?: boolean | undefined;
|
|
190
|
-
printDocStruct?: boolean | undefined;
|
|
191
|
-
printDocStructText?: boolean | undefined;
|
|
192
|
-
printIsoDates?: boolean | undefined;
|
|
193
|
-
printJS?: boolean | undefined;
|
|
194
|
-
printMetadata?: boolean | undefined;
|
|
195
|
-
printNamedDests?: boolean | undefined;
|
|
196
|
-
printRawDates?: boolean | undefined;
|
|
197
|
-
printUrls?: boolean | undefined;
|
|
198
|
-
printVersionInfo?: boolean | undefined;
|
|
199
|
-
userPassword?: string | undefined;
|
|
200
|
-
}): Promise<object | string>;
|
|
1175
|
+
pdfInfo(file: (Buffer | string), options?: PdfInfoOptions): Promise<object | string>;
|
|
201
1176
|
/**
|
|
202
1177
|
* @author Frazer Smith
|
|
203
1178
|
* @description Extracts single pages from a PDF file,
|
|
@@ -207,19 +1182,10 @@ export class Poppler {
|
|
|
207
1182
|
* @param {string} outputPattern - Should contain %d (or any variant respecting printf format),
|
|
208
1183
|
* since %d is replaced by the page number.
|
|
209
1184
|
* As an example, `sample-%d.pdf` will produce `sample-1.pdf` for a single page document.
|
|
210
|
-
* @param {
|
|
211
|
-
* @param {number} [options.firstPageToExtract] - Specifies the first page to extract.
|
|
212
|
-
* This defaults to page 1.
|
|
213
|
-
* @param {number} [options.lastPageToExtract] - Specifies the last page to extract.
|
|
214
|
-
* This defaults to the last page of the PDF file.
|
|
215
|
-
* @param {boolean} [options.printVersionInfo] - Print copyright and version info.
|
|
1185
|
+
* @param {PdfSeparateOptions} [options] - Options to pass to pdfseparate binary.
|
|
216
1186
|
* @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
|
|
217
1187
|
*/
|
|
218
|
-
pdfSeparate(file: string, outputPattern: string, options?:
|
|
219
|
-
firstPageToExtract?: number | undefined;
|
|
220
|
-
lastPageToExtract?: number | undefined;
|
|
221
|
-
printVersionInfo?: boolean | undefined;
|
|
222
|
-
}): Promise<string>;
|
|
1188
|
+
pdfSeparate(file: string, outputPattern: string, options?: PdfSeparateOptions): Promise<string>;
|
|
223
1189
|
/**
|
|
224
1190
|
* @author Frazer Smith
|
|
225
1191
|
* @description Converts a PDF file to EPS/JPEG/PDF/PNG/PS/SVG/TIFF.
|
|
@@ -231,151 +1197,10 @@ export class Poppler {
|
|
|
231
1197
|
* Encoding is set to `binary` if used with `options.singleFile` or `options.pdfFile`.
|
|
232
1198
|
*
|
|
233
1199
|
* If not set then the output filename will be derived from the PDF file name.
|
|
234
|
-
* @param {
|
|
235
|
-
* @param {('best'|'default'|'fast'|'good'|'gray'|'none'|'subpixel')} [options.antialias] - Set the cairo
|
|
236
|
-
* antialias option used for text and drawing in image files (or rasterized regions in vector output).
|
|
237
|
-
* @param {boolean} [options.cropBox] - Uses the crop box rather than media box when
|
|
238
|
-
* generating the files (PNG/JPEG/TIFF only).
|
|
239
|
-
* @param {number} [options.cropHeight] - Specifies the height of crop area in pixels
|
|
240
|
-
* (image output) or points (vector output).
|
|
241
|
-
* @param {number} [options.cropSize] - Specifies the size of crop square in pixels
|
|
242
|
-
* (image output) or points (vector output).
|
|
243
|
-
* @param {number} [options.cropWidth] - Specifies the width of crop area in pixels
|
|
244
|
-
* (image output) or points (vector output).
|
|
245
|
-
* @param {number} [options.cropXAxis] - Specifies the x-coordinate of the crop area top left
|
|
246
|
-
* corner in pixels (image output) or points (vector output).
|
|
247
|
-
* @param {number} [options.cropYAxis] - Specifies the y-coordinate of the crop area top left
|
|
248
|
-
* corner in pixels (image output) or points (vector output).
|
|
249
|
-
* @param {boolean} [options.duplex] - Adds the %%IncludeFeature: *Duplex DuplexNoTumble DSC
|
|
250
|
-
* comment to the PostScript file (PS only). This tells the print manager to enable duplexing.
|
|
251
|
-
* @param {boolean} [options.epsFile] - Generate an EPS file. An EPS file contains a single image,
|
|
252
|
-
* so if you use this option with a multi-page PDF file, you must use `options.firstPageToConvert` and
|
|
253
|
-
* `options.lastPageToConvert` to specify a single page.
|
|
254
|
-
* The page size options (originalPageSizes, paperSize, paperWidth, paperHeight) can not be used
|
|
255
|
-
* with this option.
|
|
256
|
-
* @param {boolean} [options.evenPagesOnly] - Generates only the even numbered pages.
|
|
257
|
-
* @param {boolean} [options.fillPage] - Expand PDF pages smaller than the paper to fill the
|
|
258
|
-
* paper (PS,PDF,SVG only). By default, these pages are not scaled.
|
|
259
|
-
* @param {number} [options.firstPageToConvert] - Specifies the first page to convert.
|
|
260
|
-
* @param {boolean} [options.grayscaleFile] - Generate grayscale file (PNG, JPEG, and TIFF only).
|
|
261
|
-
* @param {string} [options.iccFile] - Use the specified ICC file as the output profile
|
|
262
|
-
* (PNG only). The profile will be embedded in the PNG file.
|
|
263
|
-
* @param {boolean} [options.jpegFile] - Generate JPEG file(s).
|
|
264
|
-
* @param {string} [options.jpegOptions] - When used with `options.jpegFile`, this option can
|
|
265
|
-
* be used to control the JPEG compression parameters. It takes a string of the form
|
|
266
|
-
* `"<opt>=<val>[,<opt>=<val>]"`. Currently available options are:
|
|
267
|
-
* - `quality` Selects the JPEG quality value. The value must be an integer between 0 and 100.
|
|
268
|
-
* - `progressive` Select progressive JPEG output. The possible values are "y", "n", indicating
|
|
269
|
-
* progressive (yes) or non-progressive (no), respectively.
|
|
270
|
-
* - `optimize` Sets whether to compute optimal Huffman coding tables for the JPEG output, which
|
|
271
|
-
* will create smaller files but make an extra pass over the data. The value must be "y" or "n",
|
|
272
|
-
* with "y" performing optimization, otherwise the default Huffman tables are used.
|
|
273
|
-
*
|
|
274
|
-
* Example: `"quality=95,optimize=y"`.
|
|
275
|
-
* @param {number} [options.lastPageToConvert] - Specifies the last page to convert.
|
|
276
|
-
* @param {boolean} [options.monochromeFile] - Generate monochrome file (PNG and TIFF only).
|
|
277
|
-
* @param {boolean} [options.noCenter] - By default, PDF pages smaller than the paper
|
|
278
|
-
* (after any scaling) are centered on the paper. This option causes them to be aligned to
|
|
279
|
-
* the lower-left corner of the paper instead (PS,PDF,SVG only).
|
|
280
|
-
* @param {boolean} [options.noCrop] - By default, printing output is cropped to the CropBox
|
|
281
|
-
* specified in the PDF file. This option disables cropping (PS, PDF, SVG only).
|
|
282
|
-
* @param {boolean} [options.noShrink] - Do not scale PDF pages which are larger than the paper
|
|
283
|
-
* (PS,PDF,SVG only). By default, pages larger than the paper are shrunk to fit.
|
|
284
|
-
* @param {boolean} [options.oddPagesOnly] - Generates only the odd numbered pages.
|
|
285
|
-
* @param {boolean} [options.originalPageSizes] - Set the paper size of each page to match
|
|
286
|
-
* the size specified in the PDF file.
|
|
287
|
-
* @param {string} [options.ownerPassword] - Specify the owner password for the PDF file.
|
|
288
|
-
* Providing this will bypass all security restrictions.
|
|
289
|
-
* @param {number} [options.paperHeight] - Set the paper height, in points (PS, PDF, SVG only).
|
|
290
|
-
* @param {('A3'|'A4'|'legal'|'letter'|'match')} [options.paperSize] - Set the paper size to one of `A3`, `A4`,
|
|
291
|
-
* `legal`, or `letter` (PS,PDF,SVG only). This can also be set to `match`, which will set the paper size
|
|
292
|
-
* of each page to match the size specified in the PDF file. If none of the paperSize,
|
|
293
|
-
* paperWidth, or paperHeight options are specified the default is to match the paper size.
|
|
294
|
-
* @param {number} [options.paperWidth] - Set the paper width, in points (PS,PDF,SVG only).
|
|
295
|
-
* @param {boolean} [options.pdfFile] - Generate PDF file.
|
|
296
|
-
* @param {boolean} [options.pngFile] - Generate PNG file(s).
|
|
297
|
-
* @param {boolean} [options.printVersionInfo] - Print copyright and version information.
|
|
298
|
-
* @param {boolean} [options.printDocStruct] - If the input file contains structural information
|
|
299
|
-
* about the document's content, write this information to the output file (PDF only).
|
|
300
|
-
* @param {boolean} [options.psFile] - Generate PS file.
|
|
301
|
-
* @param {boolean} [options.psLevel2] - Generate Level 2 PostScript (PS only).
|
|
302
|
-
* @param {boolean} [options.psLevel3] - Generate Level 3 PostScript (PS only). This enables all
|
|
303
|
-
* Level 2 features plus shading patterns and masked images. This is the default setting.
|
|
304
|
-
* @param {boolean} [options.quiet] - Do not print any messages or errors.
|
|
305
|
-
* @param {number} [options.resolutionXAxis] - Specifies the X resolution, in pixels per inch of
|
|
306
|
-
* image files (or rasterized regions in vector output). The default is 150 PPI.
|
|
307
|
-
* @param {number} [options.resolutionXYAxis] - Specifies the X and Y resolution, in pixels per
|
|
308
|
-
* inch of image files (or rasterized regions in vector output). The default is 150 PPI.
|
|
309
|
-
* @param {number} [options.resolutionYAxis] - Specifies the Y resolution, in pixels per inch of
|
|
310
|
-
* image files (or rasterized regions in vector output). The default is 150 PPI.
|
|
311
|
-
* @param {number} [options.scalePageTo] - Scales the long side of each page (width for landscape
|
|
312
|
-
* pages, height for portrait pages) to fit in scale-to pixels. The size of the short side will
|
|
313
|
-
* be determined by the aspect ratio of the page (PNG/JPEG/TIFF only).
|
|
314
|
-
* @param {number} [options.scalePageToXAxis] - Scales each page horizontally to fit in scale-to-x
|
|
315
|
-
* pixels. If scale-to-y is set to -1, the vertical size will determined by the aspect ratio of
|
|
316
|
-
* the page (PNG/JPEG/TIFF only).
|
|
317
|
-
* @param {number} [options.scalePageToYAxis] - Scales each page vertically to fit in scale-to-y
|
|
318
|
-
* pixels. If scale-to-x is set to -1, the horizontal size will determined by the aspect ratio of
|
|
319
|
-
* the page (PNG/JPEG/TIFF only).
|
|
320
|
-
* @param {boolean} [options.singleFile] - Writes only the first page and does not add digits.
|
|
321
|
-
* Can only be used with `options.jpegFile`, `options.pngFile`, and `options.tiffFile`.
|
|
322
|
-
* @param {boolean} [options.svgFile] - Generate SVG (Scalable Vector Graphics) file.
|
|
323
|
-
* @param {('deflate'|'jpeg'|'lzw'|'none'|'packbits')} [options.tiffCompression] - Set TIFF compression.
|
|
324
|
-
* @param {boolean} [options.tiffFile] - Generate TIFF file(s).
|
|
325
|
-
* @param {boolean} [options.transparentPageColor] - Use a transparent page color
|
|
326
|
-
* instead of white (PNG and TIFF only).
|
|
327
|
-
* @param {string} [options.userPassword] - Specify the user password for the PDF file.
|
|
1200
|
+
* @param {PdfToCairoOptions} [options] - Options to pass to pdftocairo binary.
|
|
328
1201
|
* @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
|
|
329
1202
|
*/
|
|
330
|
-
pdfToCairo(file: Buffer | string, outputFile?: string, options?:
|
|
331
|
-
antialias?: "none" | "default" | "best" | "fast" | "good" | "gray" | "subpixel" | undefined;
|
|
332
|
-
cropBox?: boolean | undefined;
|
|
333
|
-
cropHeight?: number | undefined;
|
|
334
|
-
cropSize?: number | undefined;
|
|
335
|
-
cropWidth?: number | undefined;
|
|
336
|
-
cropXAxis?: number | undefined;
|
|
337
|
-
cropYAxis?: number | undefined;
|
|
338
|
-
duplex?: boolean | undefined;
|
|
339
|
-
epsFile?: boolean | undefined;
|
|
340
|
-
evenPagesOnly?: boolean | undefined;
|
|
341
|
-
fillPage?: boolean | undefined;
|
|
342
|
-
firstPageToConvert?: number | undefined;
|
|
343
|
-
grayscaleFile?: boolean | undefined;
|
|
344
|
-
iccFile?: string | undefined;
|
|
345
|
-
jpegFile?: boolean | undefined;
|
|
346
|
-
jpegOptions?: string | undefined;
|
|
347
|
-
lastPageToConvert?: number | undefined;
|
|
348
|
-
monochromeFile?: boolean | undefined;
|
|
349
|
-
noCenter?: boolean | undefined;
|
|
350
|
-
noCrop?: boolean | undefined;
|
|
351
|
-
noShrink?: boolean | undefined;
|
|
352
|
-
oddPagesOnly?: boolean | undefined;
|
|
353
|
-
originalPageSizes?: boolean | undefined;
|
|
354
|
-
ownerPassword?: string | undefined;
|
|
355
|
-
paperHeight?: number | undefined;
|
|
356
|
-
paperSize?: "match" | "A3" | "A4" | "legal" | "letter" | undefined;
|
|
357
|
-
paperWidth?: number | undefined;
|
|
358
|
-
pdfFile?: boolean | undefined;
|
|
359
|
-
pngFile?: boolean | undefined;
|
|
360
|
-
printVersionInfo?: boolean | undefined;
|
|
361
|
-
printDocStruct?: boolean | undefined;
|
|
362
|
-
psFile?: boolean | undefined;
|
|
363
|
-
psLevel2?: boolean | undefined;
|
|
364
|
-
psLevel3?: boolean | undefined;
|
|
365
|
-
quiet?: boolean | undefined;
|
|
366
|
-
resolutionXAxis?: number | undefined;
|
|
367
|
-
resolutionXYAxis?: number | undefined;
|
|
368
|
-
resolutionYAxis?: number | undefined;
|
|
369
|
-
scalePageTo?: number | undefined;
|
|
370
|
-
scalePageToXAxis?: number | undefined;
|
|
371
|
-
scalePageToYAxis?: number | undefined;
|
|
372
|
-
singleFile?: boolean | undefined;
|
|
373
|
-
svgFile?: boolean | undefined;
|
|
374
|
-
tiffCompression?: "none" | "deflate" | "jpeg" | "lzw" | "packbits" | undefined;
|
|
375
|
-
tiffFile?: boolean | undefined;
|
|
376
|
-
transparentPageColor?: boolean | undefined;
|
|
377
|
-
userPassword?: string | undefined;
|
|
378
|
-
}): Promise<string>;
|
|
1203
|
+
pdfToCairo(file: Buffer | string, outputFile?: string, options?: PdfToCairoOptions): Promise<string>;
|
|
379
1204
|
/**
|
|
380
1205
|
* @author Frazer Smith
|
|
381
1206
|
* @description Converts a PDF file to HTML.
|
|
@@ -385,62 +1210,10 @@ export class Poppler {
|
|
|
385
1210
|
* and create a new file, with `-html` appended to the end of the filename.
|
|
386
1211
|
*
|
|
387
1212
|
* Required if `file` is a Buffer.
|
|
388
|
-
* @param {
|
|
389
|
-
* @param {boolean} [options.complexOutput] - Generate complex output.
|
|
390
|
-
* @param {boolean} [options.dataUrls] - Use data URLs instead of external images in HTML.
|
|
391
|
-
* @param {boolean} [options.exchangePdfLinks] - Exchange .pdf links with .html.
|
|
392
|
-
* @param {boolean} [options.extractHidden] - Force hidden text extraction.
|
|
393
|
-
* @param {number} [options.firstPageToConvert] - First page to print.
|
|
394
|
-
* @param {boolean} [options.fontFullName] - Outputs the font name without any substitutions.
|
|
395
|
-
* @param {boolean} [options.ignoreImages] - Ignore images.
|
|
396
|
-
* @param {('JPG'|'PNG')} [options.imageFormat] - Image file format for Splash output (JPG or PNG).
|
|
397
|
-
* If complexOutput is selected, but imageFormat is not specified, PNG will be assumed.
|
|
398
|
-
* @param {number} [options.lastPageToConvert] - Last page to print.
|
|
399
|
-
* @param {boolean} [options.noDrm] - Override document DRM settings.
|
|
400
|
-
* @param {boolean} [options.noFrames] - Generate no frames. Not supported in complex output mode.
|
|
401
|
-
* @param {boolean} [options.noMergeParagraph] - Do not merge paragraphs.
|
|
402
|
-
* @param {boolean} [options.noRoundedCoordinates] - Do not round coordinates
|
|
403
|
-
* (with XML output only).
|
|
404
|
-
* @param {string} [options.outputEncoding] - Sets the encoding to use for text output.
|
|
405
|
-
* This defaults to `UTF-8`.
|
|
406
|
-
* @param {string} [options.ownerPassword] - Owner password (for encrypted files).
|
|
407
|
-
* @param {boolean} [options.printVersionInfo] - Print copyright and version info.
|
|
408
|
-
* @param {boolean} [options.quiet] - Do not print any messages or errors.
|
|
409
|
-
* @param {boolean} [options.singlePage] - Generate single HTML that includes all pages.
|
|
410
|
-
* @param {boolean} [options.stdout] - Use standard output.
|
|
411
|
-
* @param {string} [options.userPassword] - User password (for encrypted files).
|
|
412
|
-
* @param {number} [options.wordBreakThreshold] - Adjust the word break threshold percent.
|
|
413
|
-
* Default is 10. Word break occurs when distance between two adjacent characters is greater
|
|
414
|
-
* than this percent of character height.
|
|
415
|
-
* @param {boolean} [options.xmlOutput] - Output for XML post-processing.
|
|
416
|
-
* @param {number} [options.zoom] - Zoom the PDF document (default 1.5).
|
|
1213
|
+
* @param {PdfToHtmlOptions} [options] - Options to pass to pdftohtml binary.
|
|
417
1214
|
* @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
|
|
418
1215
|
*/
|
|
419
|
-
pdfToHtml(file: (Buffer | string), outputFile?: string, options?:
|
|
420
|
-
complexOutput?: boolean | undefined;
|
|
421
|
-
dataUrls?: boolean | undefined;
|
|
422
|
-
exchangePdfLinks?: boolean | undefined;
|
|
423
|
-
extractHidden?: boolean | undefined;
|
|
424
|
-
firstPageToConvert?: number | undefined;
|
|
425
|
-
fontFullName?: boolean | undefined;
|
|
426
|
-
ignoreImages?: boolean | undefined;
|
|
427
|
-
imageFormat?: "JPG" | "PNG" | undefined;
|
|
428
|
-
lastPageToConvert?: number | undefined;
|
|
429
|
-
noDrm?: boolean | undefined;
|
|
430
|
-
noFrames?: boolean | undefined;
|
|
431
|
-
noMergeParagraph?: boolean | undefined;
|
|
432
|
-
noRoundedCoordinates?: boolean | undefined;
|
|
433
|
-
outputEncoding?: string | undefined;
|
|
434
|
-
ownerPassword?: string | undefined;
|
|
435
|
-
printVersionInfo?: boolean | undefined;
|
|
436
|
-
quiet?: boolean | undefined;
|
|
437
|
-
singlePage?: boolean | undefined;
|
|
438
|
-
stdout?: boolean | undefined;
|
|
439
|
-
userPassword?: string | undefined;
|
|
440
|
-
wordBreakThreshold?: number | undefined;
|
|
441
|
-
xmlOutput?: boolean | undefined;
|
|
442
|
-
zoom?: number | undefined;
|
|
443
|
-
}): Promise<string>;
|
|
1216
|
+
pdfToHtml(file: (Buffer | string), outputFile?: string, options?: PdfToHtmlOptions): Promise<string>;
|
|
444
1217
|
/**
|
|
445
1218
|
* @author Frazer Smith
|
|
446
1219
|
* @description Converts a PDF file to colour image files in Portable Pixmap (PPM) format,
|
|
@@ -448,339 +1221,30 @@ export class Poppler {
|
|
|
448
1221
|
* in Portable Bitmap (PBM) format.
|
|
449
1222
|
* @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
|
|
450
1223
|
* @param {string} outputPath - Filepath to output the results to.
|
|
451
|
-
* @param {
|
|
452
|
-
* @param {('no'|'yes')} [options.antialiasFonts] - Enable or disable font anti-aliasing.
|
|
453
|
-
* This defaults to `yes`.
|
|
454
|
-
* @param {('no'|'yes')} [options.antialiasVectors] - Enable or disable vector anti-aliasing.
|
|
455
|
-
* This defaults to `yes`.
|
|
456
|
-
* @param {boolean} [options.cropBox] - Uses the crop box rather than media box when
|
|
457
|
-
* generating the files (PNG/JPEG/TIFF only).
|
|
458
|
-
* @param {number} [options.cropHeight] - Specifies the height of crop area in pixels
|
|
459
|
-
* (image output) or points (vector output).
|
|
460
|
-
* @param {number} [options.cropSize] - Specifies the size of crop square in pixels
|
|
461
|
-
* (image output) or points (vector output).
|
|
462
|
-
* @param {number} [options.cropWidth] - Specifies the width of crop area in pixels
|
|
463
|
-
* (image output) or points (vector output).
|
|
464
|
-
* @param {number} [options.cropXAxis] - Specifies the x-coordinate of the crop area top left
|
|
465
|
-
* corner in pixels (image output) or points (vector output).
|
|
466
|
-
* @param {number} [options.cropYAxis] - Specifies the y-coordinate of the crop area top left
|
|
467
|
-
* corner in pixels (image output) or points (vector output).
|
|
468
|
-
* @param {string} [options.defaultCmykProfile] - If Poppler is compiled with colour management support, this option
|
|
469
|
-
* sets the DefaultCMYK color space to the ICC profile stored in the display profile file passed.
|
|
470
|
-
* @param {string} [options.defaultGrayProfile] - If Poppler is compiled with colour management support, this option
|
|
471
|
-
* sets the DefaultGray color space to the ICC profile stored in the display profile file passed.
|
|
472
|
-
* @param {string} [options.defaultRgbProfile] - If Poppler is compiled with colour management support, this option
|
|
473
|
-
* sets the DefaultRGB color space to the ICC profile stored in the display profile file passed.
|
|
474
|
-
* @param {string} [options.displayProfile] - If Poppler is compiled with colour management support, this option
|
|
475
|
-
* sets the display profile to the ICC profile stored in the display profile file passed.
|
|
476
|
-
* @param {boolean} [options.evenPagesOnly] - Generates only the even numbered pages.
|
|
477
|
-
* @param {number} [options.firstPageToConvert] - Specifies the first page to convert.
|
|
478
|
-
* @param {('no'|'yes')} [options.freetype] - Enable or disable FreeType (a TrueType / Type 1 font rasterizer).
|
|
479
|
-
* This defaults to `yes`.
|
|
480
|
-
* @param {boolean} [options.forcePageNumber] - Force page number even if there is only one page.
|
|
481
|
-
* @param {boolean} [options.grayscaleFile] - Generate grayscale PGM file (instead of a color PPM file).
|
|
482
|
-
* @param {boolean} [options.hideAnnotations] - Hide annotations.
|
|
483
|
-
* @param {boolean} [options.jpegFile] - Generate JPEG file instead a PPM file.
|
|
484
|
-
* @param {number} [options.lastPageToConvert] - Specifies the last page to convert.
|
|
485
|
-
* @param {boolean} [options.monochromeFile] - Generate monochrome PBM file (instead of a color PPM file).
|
|
486
|
-
* @param {boolean} [options.oddPagesOnly] - Generates only the odd numbered pages.
|
|
487
|
-
* @param {string} [options.ownerPassword] - Specify the owner password for the PDF file.
|
|
488
|
-
* Providing this will bypass all security restrictions.
|
|
489
|
-
* @param {boolean} [options.pngFile] - Generate PNG file instead a PPM file.
|
|
490
|
-
* @param {boolean} [options.printProgress] - Print progress info as each page is generated.
|
|
491
|
-
* Three space-separated fields are printed to STDERR: the number of the current page, the number
|
|
492
|
-
* of the last page that will be generated, and the path to the file written to.
|
|
493
|
-
* @param {boolean} [options.printVersionInfo] - Print copyright and version information.
|
|
494
|
-
* @param {boolean} [options.quiet] - Do not print any messages or errors.
|
|
495
|
-
* @param {number} [options.resolutionXAxis] - Specifies the X resolution, in pixels per inch of
|
|
496
|
-
* image files (or rasterized regions in vector output). The default is 150 PPI.
|
|
497
|
-
* @param {number} [options.resolutionXYAxis] - Specifies the X and Y resolution, in pixels per
|
|
498
|
-
* inch of image files (or rasterized regions in vector output). The default is 150 PPI.
|
|
499
|
-
* @param {number} [options.resolutionYAxis] - Specifies the Y resolution, in pixels per inch of
|
|
500
|
-
* image files (or rasterized regions in vector output). The default is 150 PPI.
|
|
501
|
-
* @param {number} [options.scalePageTo] - Scales the long side of each page (width for landscape
|
|
502
|
-
* pages, height for portrait pages) to fit in scale-to pixels. The size of the short side will
|
|
503
|
-
* be determined by the aspect ratio of the page.
|
|
504
|
-
* @param {number} [options.scalePageToXAxis] - Scales each page horizontally to fit in scale-to-x
|
|
505
|
-
* pixels. If scale-to-y is set to -1, the vertical size will determined by the aspect ratio of
|
|
506
|
-
* the page.
|
|
507
|
-
* @param {number} [options.scalePageToYAxis] - Scales each page vertically to fit in scale-to-y
|
|
508
|
-
* pixels. If scale-to-x is set to -1, the horizontal size will determined by the aspect ratio of
|
|
509
|
-
* the page.
|
|
510
|
-
* @param {string} [options.separator] - Specify single character separator between name and page number.
|
|
511
|
-
* @param {boolean} [options.singleFile] - Writes only the first page and does not add digits.
|
|
512
|
-
* @param {('none'|'shape'|'solid')} [options.thinLineMode] - Specifies the thin line mode. This defaults to `none`.
|
|
513
|
-
* @param {('deflate'|'jpeg'|'lzw'|'none'|'packbits')} [options.tiffCompression] - Set TIFF compression.
|
|
514
|
-
* @param {boolean} [options.tiffFile] - Generate TIFF file instead a PPM file.
|
|
515
|
-
* @param {string} [options.userPassword] - Specify the user password for the PDF file.
|
|
1224
|
+
* @param {PdfToPpmOptions} [options] - Options to pass to pdftoppm binary.
|
|
516
1225
|
* @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
|
|
517
1226
|
*/
|
|
518
|
-
pdfToPpm(file: (Buffer | string), outputPath: string, options?:
|
|
519
|
-
antialiasFonts?: "no" | "yes" | undefined;
|
|
520
|
-
antialiasVectors?: "no" | "yes" | undefined;
|
|
521
|
-
cropBox?: boolean | undefined;
|
|
522
|
-
cropHeight?: number | undefined;
|
|
523
|
-
cropSize?: number | undefined;
|
|
524
|
-
cropWidth?: number | undefined;
|
|
525
|
-
cropXAxis?: number | undefined;
|
|
526
|
-
cropYAxis?: number | undefined;
|
|
527
|
-
defaultCmykProfile?: string | undefined;
|
|
528
|
-
defaultGrayProfile?: string | undefined;
|
|
529
|
-
defaultRgbProfile?: string | undefined;
|
|
530
|
-
displayProfile?: string | undefined;
|
|
531
|
-
evenPagesOnly?: boolean | undefined;
|
|
532
|
-
firstPageToConvert?: number | undefined;
|
|
533
|
-
freetype?: "no" | "yes" | undefined;
|
|
534
|
-
forcePageNumber?: boolean | undefined;
|
|
535
|
-
grayscaleFile?: boolean | undefined;
|
|
536
|
-
hideAnnotations?: boolean | undefined;
|
|
537
|
-
jpegFile?: boolean | undefined;
|
|
538
|
-
lastPageToConvert?: number | undefined;
|
|
539
|
-
monochromeFile?: boolean | undefined;
|
|
540
|
-
oddPagesOnly?: boolean | undefined;
|
|
541
|
-
ownerPassword?: string | undefined;
|
|
542
|
-
pngFile?: boolean | undefined;
|
|
543
|
-
printProgress?: boolean | undefined;
|
|
544
|
-
printVersionInfo?: boolean | undefined;
|
|
545
|
-
quiet?: boolean | undefined;
|
|
546
|
-
resolutionXAxis?: number | undefined;
|
|
547
|
-
resolutionXYAxis?: number | undefined;
|
|
548
|
-
resolutionYAxis?: number | undefined;
|
|
549
|
-
scalePageTo?: number | undefined;
|
|
550
|
-
scalePageToXAxis?: number | undefined;
|
|
551
|
-
scalePageToYAxis?: number | undefined;
|
|
552
|
-
separator?: string | undefined;
|
|
553
|
-
singleFile?: boolean | undefined;
|
|
554
|
-
thinLineMode?: "none" | "shape" | "solid" | undefined;
|
|
555
|
-
tiffCompression?: "none" | "deflate" | "jpeg" | "lzw" | "packbits" | undefined;
|
|
556
|
-
tiffFile?: boolean | undefined;
|
|
557
|
-
userPassword?: string | undefined;
|
|
558
|
-
}): Promise<string>;
|
|
1227
|
+
pdfToPpm(file: (Buffer | string), outputPath: string, options?: PdfToPpmOptions): Promise<string>;
|
|
559
1228
|
/**
|
|
560
1229
|
* @author Frazer Smith
|
|
561
1230
|
* @description Converts a PDF file to PostScript (PS).
|
|
562
1231
|
* @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
|
|
563
1232
|
* @param {string} [outputFile] - Filepath of the file to output the results to.
|
|
564
1233
|
* If `undefined` then will write output to stdout.
|
|
565
|
-
* @param {
|
|
566
|
-
* @param {('no'|'yes')} [options.antialias] - Enable anti-aliasing on rasterization, accepts `no` or `yes`.
|
|
567
|
-
* @param {boolean} [options.binary] - Write binary data in Level 1 PostScript. By default,
|
|
568
|
-
* pdftops writes hex-encoded data in Level 1 PostScript. Binary data is non-standard in Level 1
|
|
569
|
-
* PostScript but reduces the file size and can be useful when Level 1 PostScript is required
|
|
570
|
-
* only for its restricted use of PostScript operators.
|
|
571
|
-
* @param {string} [options.defaultCmykProfile] - If Poppler is compiled with colour management support, this option
|
|
572
|
-
* sets the DefaultCMYK color space to the ICC profile stored in the display profile file passed.
|
|
573
|
-
* @param {string} [options.defaultGrayProfile] - If Poppler is compiled with colour management support, this option
|
|
574
|
-
* sets the DefaultGray color space to the ICC profile stored in the display profile file passed.
|
|
575
|
-
* @param {string} [options.defaultRgbProfile] - If Poppler is compiled with colour management support, this option
|
|
576
|
-
* sets the DefaultRGB color space to the ICC profile stored in the display profile file passed.
|
|
577
|
-
* @param {boolean} [options.duplex] - Set the Duplex pagedevice entry in the PostScript file.
|
|
578
|
-
* This tells duplex-capable printers to enable duplexing.
|
|
579
|
-
* @param {boolean} [options.epsFile] - Generate an EPS file. An EPS file contains a single image,
|
|
580
|
-
* so if you use this option with a multi-page PDF file, you must use `options.firstPageToConvert` and
|
|
581
|
-
* `options.lastPageToConvert` to specify a single page.
|
|
582
|
-
* The page size options (originalPageSizes, paperSize, paperWidth, paperHeight) can not be used
|
|
583
|
-
* with this option.
|
|
584
|
-
* @param {boolean} [options.fillPage] - Expand PDF pages smaller than the paper to fill the
|
|
585
|
-
* paper. By default, these pages are not scaled.
|
|
586
|
-
* @param {number} [options.firstPageToConvert] - Specifies the first page to convert.
|
|
587
|
-
* @param {number} [options.form] - Generate PostScript form which can be imported by software
|
|
588
|
-
* that understands forms.
|
|
589
|
-
* A form contains a single page, so if you use this option with a multi-page PDF file,
|
|
590
|
-
* you must use `options.firstPageToConvert` and `options.lastPageToConvert` to specify a single page.
|
|
591
|
-
* The `options.level1` option cannot be used with `options.form`.
|
|
592
|
-
* No more than one of the mode options (`options.epsFile`, `options.form`) may be given.
|
|
593
|
-
* @param {number} [options.lastPageToConvert] - Specifies the last page to convert.
|
|
594
|
-
* @param {boolean} [options.level1] - Generate Level 1 PostScript. The resulting PostScript
|
|
595
|
-
* files will be significantly larger (if they contain images), but will print on Level 1 printers.
|
|
596
|
-
* This also converts all images to black and white.
|
|
597
|
-
* @param {boolean} [options.level1Sep] - Generate Level 1 separable PostScript.
|
|
598
|
-
* All colors are converted to CMYK. Images are written with separate stream data for the four components.
|
|
599
|
-
* @param {boolean} [options.level2] - Generate Level 2 PostScript.
|
|
600
|
-
* Level 2 supports color images and image compression. This is the default setting.
|
|
601
|
-
* @param {boolean} [options.level2Sep] - Generate Level 2 separable PostScript. All colors are
|
|
602
|
-
* converted to CMYK. The PostScript separation convention operators are used to handle custom (spot) colors.
|
|
603
|
-
* @param {boolean} [options.level3] - Generate Level 3 PostScript.
|
|
604
|
-
* This enables all Level 2 featuresplus CID font embedding.
|
|
605
|
-
* @param {boolean} [options.level3Sep] - Generate Level 3 separable PostScript.
|
|
606
|
-
* The separation handling is the same as for `options.level2Sep`.
|
|
607
|
-
* @param {boolean} [options.noCenter] - By default, PDF pages smaller than the paper
|
|
608
|
-
* (after any scaling) are centered on the paper. This option causes them to be aligned to
|
|
609
|
-
* the lower-left corner of the paper instead.
|
|
610
|
-
* @param {boolean} [options.noCrop] - By default, printing output is cropped to the CropBox
|
|
611
|
-
* specified in the PDF file. This option disables cropping.
|
|
612
|
-
* @param {boolean} [options.noEmbedCIDFonts] - By default, any CID PostScript fonts which are
|
|
613
|
-
* embedded in the PDF file are copied into the PostScript file. This option disables that embedding.
|
|
614
|
-
* No attempt is made to substitute for non-embedded CID PostScript fonts.
|
|
615
|
-
* @param {boolean} [options.noEmbedCIDTrueTypeFonts] - By default, any CID TrueType fonts which are
|
|
616
|
-
* embedded in the PDF file are copied into the PostScript file. This option disables that embedding.
|
|
617
|
-
* No attempt is made to substitute for non-embedded CID TrueType fonts.
|
|
618
|
-
* @param {boolean} [options.noEmbedTrueTypeFonts] - By default, any TrueType fonts which are embedded
|
|
619
|
-
* in the PDF file are copied into the PostScript file. This option causes pdfToPs to substitute base fonts instead.
|
|
620
|
-
* Embedded fonts make PostScript files larger, but may be necessary for readable output.
|
|
621
|
-
* Also, some PostScript interpreters do not have TrueType rasterizers.
|
|
622
|
-
* @param {boolean} [options.noEmbedType1Fonts] - By default, any Type 1 fonts which are embedded in the PDF file
|
|
623
|
-
* are copied into the PostScript file. This option causes pdfToPs to substitute base fonts instead.
|
|
624
|
-
* Embedded fonts make PostScript files larger, but may be necessary for readable output.
|
|
625
|
-
* @param {boolean} [options.noShrink] - Do not scale PDF pages which are larger than the paper.
|
|
626
|
-
* By default, pages larger than the paper are shrunk to fit.
|
|
627
|
-
* @param {boolean} [options.opi] - Generate OPI comments for all images and forms which have OPI information.
|
|
628
|
-
* @param {boolean} [options.optimizecolorspace] - By default, bitmap images in the PDF pass through to the
|
|
629
|
-
* output PostScript in their original color space, which produces predictable results.
|
|
630
|
-
* This option converts RGB and CMYK images into Gray images if every pixel of the image has equal components.
|
|
631
|
-
* This can fix problems when doing color separations of PDFs that contain embedded black and
|
|
632
|
-
* white images encoded as RGB.
|
|
633
|
-
* @param {boolean} [options.originalPageSizes] - Set the paper size of each page to match
|
|
634
|
-
* the size specified in the PDF file.
|
|
635
|
-
* @param {boolean} [options.overprint] - Enable overprinting.
|
|
636
|
-
* @param {string} [options.ownerPassword] - Owner password (for encrypted files).
|
|
637
|
-
* @param {number} [options.paperHeight] - Set the paper height, in points.
|
|
638
|
-
* @param {('A3'|'A4'|'legal'|'letter'|'match')} [options.paperSize] - Set the paper size to one of `A3`, `A4`,
|
|
639
|
-
* `legal`, or `letter`. This can also be set to `match`, which will set the paper size
|
|
640
|
-
* of each page to match the size specified in the PDF file. If none of the paperSize,
|
|
641
|
-
* paperWidth, or paperHeight options are specified the default is to match the paper size.
|
|
642
|
-
* @param {number} [options.paperWidth] - Set the paper width, in points.
|
|
643
|
-
* @param {boolean} [options.passfonts] - By default, references to non-embedded 8-bit fonts
|
|
644
|
-
* in the PDF file are substituted with the closest `Helvetica`, `Times-Roman`, or `Courier` font.
|
|
645
|
-
* This option passes references to non-embedded fonts through to the PostScript file.
|
|
646
|
-
* @param {boolean} [options.preload] - Preload images and forms.
|
|
647
|
-
* @param {boolean} [options.printVersionInfo] - Print copyright and version information.
|
|
648
|
-
* @param {('CMYK8'|'MONO8'|'RGB8')} [options.processColorFormat] - Sets the process color format as it is used
|
|
649
|
-
* during rasterization and transparency reduction.
|
|
650
|
-
*
|
|
651
|
-
* The default depends on the other settings: For `options.level1` the default is MONO8; for `options.level1Sep`,
|
|
652
|
-
* `options.level2Sep`, `options.level3Sep`, or `options.overprint` the default is CMYK8; in all other
|
|
653
|
-
* cases RGB8 is the default.
|
|
654
|
-
* If `option.processColorProfile` is set then `options.processColorFormat` is inferred from the specified ICC profile.
|
|
655
|
-
* @param {string} [options.processColorProfile] - Sets the ICC profile that is assumed during
|
|
656
|
-
* rasterization and transparency reduction.
|
|
657
|
-
* @param {boolean} [options.quiet] - Do not print any messages or errors.
|
|
658
|
-
* @param {('always'|'never'|'whenneeded')} [options.rasterize] - By default, pdfToPs rasterizes pages as needed,
|
|
659
|
-
* for example, if they contain transparencies. To force rasterization, set `rasterize` to `always`.
|
|
660
|
-
* Use this to eliminate fonts.
|
|
661
|
-
* To prevent rasterization, set `rasterize` to `never`.
|
|
662
|
-
* This may produce files that display incorrectly.
|
|
663
|
-
* @param {number} [options.resolutionXYAxis] - Specifies the X and Y resolution, in pixels per
|
|
664
|
-
* inch of image files (or rasterized regions in vector output). The default is 300 PPI.
|
|
665
|
-
* @param {string} [options.userPassword] - User password (for encrypted files).
|
|
1234
|
+
* @param {PdfToPsOptions} [options] - Options to pass to pdftops binary.
|
|
666
1235
|
* @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
|
|
667
1236
|
*/
|
|
668
|
-
pdfToPs(file: (Buffer | string), outputFile?: string, options?:
|
|
669
|
-
antialias?: "no" | "yes" | undefined;
|
|
670
|
-
binary?: boolean | undefined;
|
|
671
|
-
defaultCmykProfile?: string | undefined;
|
|
672
|
-
defaultGrayProfile?: string | undefined;
|
|
673
|
-
defaultRgbProfile?: string | undefined;
|
|
674
|
-
duplex?: boolean | undefined;
|
|
675
|
-
epsFile?: boolean | undefined;
|
|
676
|
-
fillPage?: boolean | undefined;
|
|
677
|
-
firstPageToConvert?: number | undefined;
|
|
678
|
-
form?: number | undefined;
|
|
679
|
-
lastPageToConvert?: number | undefined;
|
|
680
|
-
level1?: boolean | undefined;
|
|
681
|
-
level1Sep?: boolean | undefined;
|
|
682
|
-
level2?: boolean | undefined;
|
|
683
|
-
level2Sep?: boolean | undefined;
|
|
684
|
-
level3?: boolean | undefined;
|
|
685
|
-
level3Sep?: boolean | undefined;
|
|
686
|
-
noCenter?: boolean | undefined;
|
|
687
|
-
noCrop?: boolean | undefined;
|
|
688
|
-
noEmbedCIDFonts?: boolean | undefined;
|
|
689
|
-
noEmbedCIDTrueTypeFonts?: boolean | undefined;
|
|
690
|
-
noEmbedTrueTypeFonts?: boolean | undefined;
|
|
691
|
-
noEmbedType1Fonts?: boolean | undefined;
|
|
692
|
-
noShrink?: boolean | undefined;
|
|
693
|
-
opi?: boolean | undefined;
|
|
694
|
-
optimizecolorspace?: boolean | undefined;
|
|
695
|
-
originalPageSizes?: boolean | undefined;
|
|
696
|
-
overprint?: boolean | undefined;
|
|
697
|
-
ownerPassword?: string | undefined;
|
|
698
|
-
paperHeight?: number | undefined;
|
|
699
|
-
paperSize?: "match" | "A3" | "A4" | "legal" | "letter" | undefined;
|
|
700
|
-
paperWidth?: number | undefined;
|
|
701
|
-
passfonts?: boolean | undefined;
|
|
702
|
-
preload?: boolean | undefined;
|
|
703
|
-
printVersionInfo?: boolean | undefined;
|
|
704
|
-
processColorFormat?: "CMYK8" | "MONO8" | "RGB8" | undefined;
|
|
705
|
-
processColorProfile?: string | undefined;
|
|
706
|
-
quiet?: boolean | undefined;
|
|
707
|
-
rasterize?: "always" | "never" | "whenneeded" | undefined;
|
|
708
|
-
resolutionXYAxis?: number | undefined;
|
|
709
|
-
userPassword?: string | undefined;
|
|
710
|
-
}): Promise<string>;
|
|
1237
|
+
pdfToPs(file: (Buffer | string), outputFile?: string, options?: PdfToPsOptions): Promise<string>;
|
|
711
1238
|
/**
|
|
712
1239
|
* @author Frazer Smith
|
|
713
1240
|
* @description Converts a PDF file to TXT.
|
|
714
1241
|
* @param {(Buffer|string)} file - PDF file as Buffer, or filepath of the PDF file to read.
|
|
715
1242
|
* @param {string} [outputFile] - Filepath of the file to output the results to.
|
|
716
1243
|
* If `undefined` then will write output to stdout.
|
|
717
|
-
* @param {
|
|
718
|
-
* @param {boolean} [options.boundingBoxXhtml] - Generate an XHTML file containing bounding
|
|
719
|
-
* box information for each word in the file.
|
|
720
|
-
* @param {boolean} [options.boundingBoxXhtmlLayout] - Generate an XHTML file containing
|
|
721
|
-
* bounding box information for each block, line, and word in the file.
|
|
722
|
-
* @param {boolean} [options.cropBox] - Use the crop box rather than the media box with
|
|
723
|
-
* `options.boundingBoxXhtml` and `options.boundingBoxXhtmlLayout`.
|
|
724
|
-
* @param {number} [options.cropHeight] - Specifies the height of crop area in pixels
|
|
725
|
-
* (image output) or points (vector output).
|
|
726
|
-
* @param {number} [options.cropWidth] - Specifies the width of crop area in pixels
|
|
727
|
-
* (image output) or points (vector output).
|
|
728
|
-
* @param {number} [options.cropXAxis] - Specifies the x-coordinate of the crop area top left
|
|
729
|
-
* corner in pixels (image output) or points (vector output).
|
|
730
|
-
* @param {number} [options.cropYAxis] - Specifies the y-coordinate of the crop area top left
|
|
731
|
-
* corner in pixels (image output) or points (vector output).
|
|
732
|
-
* @param {('dos'|'mac'|'unix')} [options.eolConvention] - Sets the end-of-line convention to use for
|
|
733
|
-
* text output: dos; mac; unix.
|
|
734
|
-
* @param {number} [options.firstPageToConvert] - Specifies the first page to convert.
|
|
735
|
-
* @param {number} [options.fixedWidthLayout] - Assume fixed-pitch (or tabular) text, with the
|
|
736
|
-
* specified character width (in points). This forces physical layout mode.
|
|
737
|
-
* @param {boolean} [options.generateHtmlMetaFile] - Generate simple HTML file, including the
|
|
738
|
-
* meta information. This simply wraps the text in `<pre>` and `</pre>` and prepends the meta headers.
|
|
739
|
-
* @param {boolean} [options.generateTsvFile] - Generate a TSV file containing the bounding box
|
|
740
|
-
* information for each block, line, and word in the file.
|
|
741
|
-
* @param {number} [options.lastPageToConvert] - Specifies the last page to convert.
|
|
742
|
-
* @param {boolean} [options.listEncodingOptions] - List the available encodings.
|
|
743
|
-
* @param {boolean} [options.maintainLayout] - Maintain (as best as possible) the original physical
|
|
744
|
-
* layout of the text. The default is to undo physical layout (columns, hyphenation, etc.) and
|
|
745
|
-
* output the text in reading order.
|
|
746
|
-
* @param {boolean} [options.noDiagonalText] - Discard diagonal text.
|
|
747
|
-
* @param {boolean} [options.noPageBreaks] - Do not insert page breaks (form feed characters)
|
|
748
|
-
* between pages.
|
|
749
|
-
* @param {string} [options.outputEncoding] - Sets the encoding to use for text output.
|
|
750
|
-
* This defaults to `UTF-8`.
|
|
751
|
-
* @param {string} [options.ownerPassword] - Owner password (for encrypted files).
|
|
752
|
-
* @param {boolean} [options.printVersionInfo] - Print copyright and version information.
|
|
753
|
-
* @param {boolean} [options.quiet] - Do not print any messages or errors.
|
|
754
|
-
* @param {boolean} [options.rawLayout] - Keep the text in content stream order. This is a
|
|
755
|
-
* hack which often undoes column formatting, etc. Use of raw mode is no longer recommended.
|
|
756
|
-
* @param {string} [options.userPassword] - User password (for encrypted files).
|
|
1244
|
+
* @param {PdfToTextOptions} [options] - Options to pass to pdftotext binary.
|
|
757
1245
|
* @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
|
|
758
1246
|
*/
|
|
759
|
-
pdfToText(file: (Buffer | string), outputFile?: string, options?:
|
|
760
|
-
boundingBoxXhtml?: boolean | undefined;
|
|
761
|
-
boundingBoxXhtmlLayout?: boolean | undefined;
|
|
762
|
-
cropBox?: boolean | undefined;
|
|
763
|
-
cropHeight?: number | undefined;
|
|
764
|
-
cropWidth?: number | undefined;
|
|
765
|
-
cropXAxis?: number | undefined;
|
|
766
|
-
cropYAxis?: number | undefined;
|
|
767
|
-
eolConvention?: "dos" | "mac" | "unix" | undefined;
|
|
768
|
-
firstPageToConvert?: number | undefined;
|
|
769
|
-
fixedWidthLayout?: number | undefined;
|
|
770
|
-
generateHtmlMetaFile?: boolean | undefined;
|
|
771
|
-
generateTsvFile?: boolean | undefined;
|
|
772
|
-
lastPageToConvert?: number | undefined;
|
|
773
|
-
listEncodingOptions?: boolean | undefined;
|
|
774
|
-
maintainLayout?: boolean | undefined;
|
|
775
|
-
noDiagonalText?: boolean | undefined;
|
|
776
|
-
noPageBreaks?: boolean | undefined;
|
|
777
|
-
outputEncoding?: string | undefined;
|
|
778
|
-
ownerPassword?: string | undefined;
|
|
779
|
-
printVersionInfo?: boolean | undefined;
|
|
780
|
-
quiet?: boolean | undefined;
|
|
781
|
-
rawLayout?: boolean | undefined;
|
|
782
|
-
userPassword?: string | undefined;
|
|
783
|
-
}): Promise<string>;
|
|
1247
|
+
pdfToText(file: (Buffer | string), outputFile?: string, options?: PdfToTextOptions): Promise<string>;
|
|
784
1248
|
/**
|
|
785
1249
|
* @author Frazer Smith
|
|
786
1250
|
* @description Merges several PDF files in order of their occurrence in the files array to
|
|
@@ -788,12 +1252,10 @@ export class Poppler {
|
|
|
788
1252
|
* @param {string[]} files - Filepaths of the PDF files to merge.
|
|
789
1253
|
* An entire directory of PDF files can be merged like so: `path/to/directory/*.pdf`.
|
|
790
1254
|
* @param {string} outputFile - Filepath of the file to output the resulting merged PDF to.
|
|
791
|
-
* @param {
|
|
792
|
-
* @param {boolean} [options.printVersionInfo] - Print copyright and version information.
|
|
1255
|
+
* @param {PdfUniteOptions} [options] - Options to pass to pdfunite binary.
|
|
793
1256
|
* @returns {Promise<string>} A promise that resolves with a stdout string, or rejects with an `Error` object.
|
|
794
1257
|
*/
|
|
795
|
-
pdfUnite(files: string[], outputFile: string, options?:
|
|
796
|
-
printVersionInfo?: boolean | undefined;
|
|
797
|
-
}): Promise<string>;
|
|
1258
|
+
pdfUnite(files: string[], outputFile: string, options?: PdfUniteOptions): Promise<string>;
|
|
798
1259
|
#private;
|
|
799
1260
|
}
|
|
1261
|
+
//# sourceMappingURL=index.d.ts.map
|