Interface PdfDocument

An open PDF handle. Operations are serialized per document; release it with close in a finally block.

interface PdfDocument {
    pageCount: number;
    close(): Promise<void>;
    extractImage(
        id: string,
        options?: ExtractImageOptions,
    ): Promise<ExtractedImage>;
    getImages(options?: GetImagesOptions): Promise<readonly EmbeddedImage[]>;
    getStructuredText(options?: StructuredTextOptions): Promise<StructuredText>;
}

Index

Methods

close extractImage getImages getStructuredText

Properties

Methods

close

close(): Promise<void>
Idempotently cancel queued work and join engine cleanup. Returned data remains valid; the OCR provider stays open.

Returns Promise<void>
- Defined in packages/core/src/contracts.ts:116

extractImage

extractImage(id: string, options?: ExtractImageOptions): Promise<ExtractedImage>
Export a selected appearance as owned PNG bytes. Unknown IDs fail; native export never silently downscales.
Parameters
- id: string
- Optionaloptions: ExtractImageOptions
Returns Promise<ExtractedImage>
- Defined in packages/core/src/contracts.ts:114

getImages

getImages(options?: GetImagesOptions): Promise<readonly EmbeddedImage[]>
Enumerate appearances and placements, including inline/nested/reused images. Raster decoding happens on demand.
Parameters
- Optionaloptions: GetImagesOptions
Returns Promise<readonly EmbeddedImage[]>
- Defined in packages/core/src/contracts.ts:112

getStructuredText

getStructuredText(options?: StructuredTextOptions): Promise<StructuredText>
Extract native/OCR text with deterministic geometry-based ordering. Auto OCR includes image regions on mixed pages.
Parameters
- Optionaloptions: StructuredTextOptions
Returns Promise<StructuredText>
- Defined in packages/core/src/contracts.ts:110

Properties

`Readonly`pageCount

pageCount: number

Total pages in the input PDF, independent of per-operation page selection.