Mika Scraper / EnhanceImageOptions

Interface: EnhanceImageOptions

Defined in: src/enchant-image/ihance.ts:11

The EnhanceImageOptions interface provides configuration options for the image enhancement process.

Properties

image

image: string | Buffer<ArrayBufferLike>

Defined in: src/enchant-image/ihance.ts:15

The input for image enhancement, which can be provided as a file path (string) or a binary buffer. This parameter is required.

saveToFile?

optional saveToFile: boolean

Defined in: src/enchant-image/ihance.ts:20

An optional boolean flag that determines whether the enhanced image should be saved to the local filesystem. If set to true, the enhanced image will be saved.

outputDir?

optional outputDir: string

Defined in: src/enchant-image/ihance.ts:25

An optional string that specifies the directory path where the enhanced image will be saved if saveToFile is set to true. If not provided, the image will be saved to the default directory.

Example

The following TypeScript example demonstrates how to use the EnhanceImageOptions interface for enhancing an image:


import { EnhanceImageOptions } from 'mika-scraper';
 
const options: EnhanceImageOptions = {
    image: 'path/to/image.jpg',
    saveToFile: true,
    outputDir: 'path/to/output/'
};
 
// Function call to enhance the image would go here.

Diagram: Mika Scraper