Interface GetImagesOptions

Inventory selection. Images are enumerated without retaining all decoded rasters.

interface GetImagesOptions {
    onProgress?: (event: ProgressEvent) => void;
    pages?: readonly number[];
    signal?: AbortSignal;
}

Properties

onProgress?: (event: ProgressEvent) => void

Called during work. Keep callbacks lightweight and avoid throwing.

pages?: readonly number[]

One-based pages whose image occurrences are included; omitted means all pages.

signal?: AbortSignal

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