Class ExtractedMultiReceiptImage

Wrapper class for extracted multiple-receipts images.

Hierarchy (View Summary)

ExtractedImage
- ExtractedMultiReceiptImage

Index

Constructors

Properties

buffer internalFileName pageId receiptId

Methods

asSource saveToFile saveToFileAsync

Constructors

constructor

new ExtractedMultiReceiptImage(
    buffer: Uint8Array,
    pageId: number,
    receiptId: number,
): imageOperations.ExtractedMultiReceiptImage
Parameters
- buffer: Uint8Array
- pageId: number
- receiptId: number
Returns imageOperations.ExtractedMultiReceiptImage
Overrides ExtractedImage.constructor
- Defined in src/imageOperations/multiReceiptsExtractor/extractedMultiReceiptImage.ts:10

Properties

buffer

buffer: Buffer

`Protected`internalFileName

internalFileName: string

`Readonly`pageId

pageId: number

`Readonly`receiptId

receiptId: number

Methods

asSource

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

Returns BufferInput
A BufferInput source.
Inherited from ExtractedImage.asSource
- 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
Inherited from ExtractedImage.saveToFile
- 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>
Inherited from ExtractedImage.saveToFileAsync
- Defined in src/imageOperations/common/extractedImage.ts:29