Class ExtractedImage

Generic class for image extraction

Hierarchy (View Summary)

ExtractedImage
- imageOperations.ExtractedMultiReceiptImage
- imageOperations.ExtractedInvoiceSplitterImage

Index

Constructors

Properties

buffer internalFileName

Methods

asSource saveToFile saveToFileAsync

Constructors

`Protected`constructor

new ExtractedImage(buffer: Uint8Array, fileName: string): ExtractedImage
Parameters
- buffer: Uint8Array
- fileName: string
Returns ExtractedImage
- Defined in src/imageOperations/common/extractedImage.ts:19

Properties

buffer

buffer: Buffer

`Protected`internalFileName

internalFileName: string

Methods

asSource

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

Returns BufferInput
A BufferInput source.
- Defined in src/imageOperations/common/extractedImage.ts:101

saveToFile

saveToFile(outputPath: string): void
Attempts to saves the document to a file synchronously. Throws an error if the file extension is not supported or if the file could not be saved to disk for some reason.
Parameters
- outputPath: string
  Path to save the file to.
Returns void
- Defined in src/imageOperations/common/extractedImage.ts:75

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/imageOperations/common/extractedImage.ts:29