pdfextract API
    Preparing search index...

    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<ImageList>;
        getStructuredText(options?: StructuredTextOptions): Promise<StructuredText>;
    }
    Index
    • Idempotently cancel queued work and join engine cleanup. Returned data remains valid; the OCR provider stays open.

      Returns Promise<void>

    • Enumerate appearances and placements, including inline/nested/reused images. Raster decoding happens on demand. minWidth/minHeight leave out small images; all images are listed by default. Each occurrence reports whether the page draws something above it (overlaid).

      Parameters

      Returns Promise<ImageList>

    pageCount: number

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