Interface UseLeaderboardResult

Return shape for useLeaderboard.

interface UseLeaderboardResult {
    currentTotal: number;
    donations: TiltifyDonation[];
    error: Error | null;
    exclusions: string[];
    hasNextPage: boolean;
    isFetching: boolean;
    isFetchingNextPage: boolean;
    isLoadingDonations: boolean;
    isLoadingExclusions: boolean;
    leaderboard: LeaderboardRow[];
}

Properties

currentTotal: number

Sum of every donation's amount.value (pre-exclusion).

donations: TiltifyDonation[]

Flat list of every donation aggregated (pre-limit).

error: Error | null

exclusions: string[]

Server-side exclusion list used for prefiltering.

hasNextPage: boolean

isFetching: boolean

isFetchingNextPage: boolean

isLoadingDonations: boolean

isLoadingExclusions: boolean

leaderboard: LeaderboardRow[]

Ranked, exclusion-filtered leaderboard, capped by limit.