Class ExtractedPdf

Represents a PDF artifact produced by an extraction/splitting operation.

Hierarchy (View Summary)

ExtractedPdf
- ExtractedInvoiceSplitterImage

Index

Constructors

Properties

buffer filename pageCount pageIndexes

Methods

asInputSource saveToFile saveToFileAsync

Constructors

constructor

new ExtractedPdf(
    pdfData: Buffer<ArrayBufferLike>,
    filename: string,
    pageIndexes: number[],
): ExtractedPdf
Parameters
- pdfData: Buffer<ArrayBufferLike>
- filename: string
- pageIndexes: number[]
Returns ExtractedPdf
- Defined in src/pdf/extractedPdf.ts:20

Properties

`Readonly`buffer

buffer: Buffer

Raw bytes of the extracted PDF segment.

`Readonly`filename

filename: string

Filename suggested for export.

`Readonly`pageCount

pageCount: number

Number of pages in this extracted PDF.

`Readonly`pageIndexes

pageIndexes: number[]

Zero-based indexes of pages included in this extracted PDF.

Methods

asInputSource

asInputSource(): BufferInput
Return the file as a Mindee-compatible BufferInput source.

Returns BufferInput
A BufferInput source.
- Defined in src/pdf/extractedPdf.ts:72

saveToFile

saveToFile(outputPath: string): void
Saves the document to a file synchronously.
Parameters
- outputPath: string
Returns void
- Defined in src/pdf/extractedPdf.ts:54

saveToFileAsync

saveToFileAsync(outputPath: string): Promise<void>
Saves the document to a file.
Parameters
- outputPath: string
  Path to save the file to.
Returns Promise<void>
- Defined in src/pdf/extractedPdf.ts:32