@playlive/twitch-charity
    Preparing search index...

    Interface FetchTwitchCampaignDonationsOptions

    Inputs for fetchTwitchCampaignDonations.

    interface FetchTwitchCampaignDonationsOptions {
        baseUrl: string;
        campaignId: string;
        completedAfter?: string | null;
        completedBefore?: string | null;
        count?: number;
        fetch?: typeof fetch;
        pageNumber?: number | null;
        signal?: AbortSignal;
    }

    Hierarchy (View Summary)

    Index
    baseUrl campaignId completedAfter? completedBefore? count? fetch? pageNumber? signal?
    baseUrl: string

    Absolute URL of the Twitch charity proxy (no trailing slash).

    "https://twitch-charity-proxy.experience.stjude.org"
    campaignId: string

    Campaign ID as exposed by the proxy.

    completedAfter?: string | null

    Filter — donations completed after this ISO-8601 timestamp.

    completedBefore?: string | null

    Filter — donations completed before this ISO-8601 timestamp.

    count?: number

    Page size (default 100, mirrors the upstream proxy default).

    fetch?: typeof fetch

    Optional fetch override — defaults to the global fetch. Use this for testing or to plug in a wrapped fetch (retries, tracing, etc.).

    pageNumber?: number | null

    Zero-indexed page number (default 0).

    signal?: AbortSignal

    Optional AbortSignal forwarded to the underlying request. The caller owns the controller; this client never aborts on its own.

    Settings
    Member Visibility

    On This Page
    Properties