Interface ExtractImageOptions

Export options. Omitting both bounds requests native dimensions; supplying a bound explicitly requests a thumbnail.

interface ExtractImageOptions {
    maxHeight?: number;
    maxWidth?: number;
    onProgress?: (event: ProgressEvent) => void;
    signal?: AbortSignal;
}

Properties

maxHeight?: number

Positive maximum thumbnail height in pixels. The full export is unchanged by preview generation.

maxWidth?: number

Positive maximum thumbnail width in pixels. Aspect ratio is preserved and images are not enlarged.

onProgress?: (event: ProgressEvent) => void

Called during work. Keep callbacks lightweight and avoid throwing.

signal?: AbortSignal

Aborts queued work promptly; a synchronous engine decode already running may finish before cleanup.