@effortlessmotion/pdf-to-md
    Preparing search index...

    Interface ExtractOcrOptions

    Options for extractOcr.

    interface ExtractOcrOptions {
        dpi?: number;
        fallback?: boolean;
        onProgress?: (e: OcrProgressEvent) => void;
        onWarning?: (message: string) => void;
        onWords?: (words: PageWord[]) => void;
        pages?: PageSelection;
        tuning?: Partial<Tuning>;
    }

    Hierarchy

    • CommonOptions
      • ExtractOcrOptions
    Index
    dpi? fallback? onProgress? onWarning? onWords? pages? tuning?
    dpi?: number

    page-render resolution for engine recognition (default 288, measured;

    ~400 measured WORSE on ordinary pages — not a "bigger is safer" knob)

    fallback?: boolean

    marks report.ocrFallback — set by pdfToMarkdown's auto-fallback

    onProgress?: (e: OcrProgressEvent) => void

    one event per page as recognition finishes (timing/count only — engine chatter and the sparse-retry notice arrive via onWarning instead)

    onWarning?: (message: string) => void

    delivered as each warning happens (also returned, in full, as warnings on the resolved result)

    onWords?: (words: PageWord[]) => void

    every recognized word entering the geometry, delivered once after recognition — the severity-1 audit instrument (--debug-words)

    pages?: PageSelection

    convert only this page range (1-based, inclusive); defaults to the whole document

    tuning?: Partial<Tuning>

    override any subset of the OCR-path geometry defaults — see DEFAULT_TUNING (src/geometry.ts) for each knob's measured default

    Settings
    Member Visibility

    On This Page
    Properties