Class ExtractedImage

Generic class for image extraction.

Hierarchy (View Summary)

ExtractedImage
- ExtractedMultiReceiptImage

Index

Constructors

Properties

buffer elementId filename pageId

Methods

asInputSource saveToFile saveToFileAsync

Constructors

constructor

new ExtractedImage(
    buffer: Uint8Array,
    fileName: string,
    pageId: number,
    elementId: number,
): ExtractedImage
Parameters
- buffer: Uint8Array
- fileName: string
- pageId: number
- elementId: number
Returns ExtractedImage
- Defined in src/image/extractedImage.ts:26

Properties

buffer

buffer: Buffer

Raw file bytes for the extracted image artifact.

`Readonly`elementId

elementId: number

Identifier of the extracted element on the page.

filename

filename: string

Filename used when exporting the extracted image.

`Readonly`pageId

pageId: number

1-based source page identifier.

Methods

asInputSource

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

Returns BufferInput
A BufferInput source.
- Defined in src/image/extractedImage.ts:112

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/image/extractedImage.ts:87

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/image/extractedImage.ts:38