Reviewer Suggestion
    Preparing search index...

    Interface ProviderOptions

    Transport configuration; tokens are supplied by the caller, never logged.

    interface ProviderOptions {
        apiUrl?: string;
        concurrency?: number;
        fetch?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        logger?: Logger;
        maxPages?: number;
        retries?: number;
        signal?: AbortSignal;
        timeoutMs?: number;
        token: string;
    }
    Index
    apiUrl? concurrency? fetch? logger? maxPages? retries? signal? timeoutMs? token
    apiUrl?: string

    Full API root, including /api/v3 or /api/v4 on custom hosts.

    concurrency?: number

    Maximum simultaneous HTTP attempts for this provider.

    5
    fetch?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    Injectable Fetch implementation; defaults to the Node.js global fetch.

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

    logger?: Logger

    Optional Consola-compatible observer; defaults to silent operation.

    maxPages?: number

    Pagination safety bound; hitting it reports truncation.

    100
    retries?: number

    Extra attempts for rate-limited/server-failed reads.

    2
    signal?: AbortSignal

    Cancels queued and active requests for this provider instance.

    timeoutMs?: number

    Positive timeout per HTTP attempt in milliseconds.

    15000
    token: string

    API credential; kept in transport headers and omitted from diagnostics.

    Settings
    Member Visibility

    On This Page
    Properties