pdfrx_web
    Preparing search index...

    Interface PdfOpenUrlOptions

    Options for PdfrxEngine.openUrl; extends PdfOpenOptions with fetch-related settings.

    interface PdfOpenUrlOptions {
        firstAttemptByEmptyPassword?: boolean;
        headers?: Record<string, string>;
        passwordProvider?: PdfPasswordProvider;
        preferRangeAccess?: boolean;
        progressCallback?: PdfDownloadProgressCallback;
        sourceName?: string;
        useProgressiveLoading?: boolean;
        withCredentials?: boolean;
    }

    Hierarchy (View Summary)

    Index
    firstAttemptByEmptyPassword? headers? passwordProvider? preferRangeAccess? progressCallback? sourceName? useProgressiveLoading? withCredentials?
    firstAttemptByEmptyPassword?: boolean

    Try an empty password before consulting passwordProvider. Default: true.

    headers?: Record<string, string>

    Extra HTTP headers for the fetch (e.g. authorization).

    passwordProvider?: PdfPasswordProvider

    Supplies passwords for encrypted documents; see PdfPasswordProvider for retry semantics.

    preferRangeAccess?: boolean

    Access the file via HTTP range requests instead of downloading it whole. Requires a CORS-enabled server that honors range requests.

    progressCallback?: PdfDownloadProgressCallback

    Invoked as the document downloads (see PdfDownloadProgressCallback).

    sourceName?: string

    Identifier used in error messages and for caching purposes.

    useProgressiveLoading?: boolean

    Load only the first page eagerly; call PdfDocument.loadPagesProgressively for the rest.

    withCredentials?: boolean

    Whether the fetch includes credentials (cookies, HTTP auth).

    Settings
    Member Visibility

    On This Page
    Properties