@playlive/react-query

@playlive/react-query — TanStack Query hooks over @playlive/fundraiser-data. API-compatible with @playlive/react-data (same hook names + same parameter shape + same UseFetchResult return) so consumers can swap tiers with a single import rewrite.

Use this tier when you want cache sharing across components, request deduplication, background refetch, suspense / streaming integration, or any of the other goodies TanStack Query gives you for free. For the lighter "no-cache, no-dedup" tier see @playlive/react-data.

Subpath exports (PRD §5.15, jose-style):

@playlive/react-query — full barrel (this file).
@playlive/react-query/config — workspace defaults + makeQueryClient factory.
@playlive/react-query/types — UseFetchResult, UseFetchOptions, UseInfiniteDonationsResult.

Peer deps: react, @tanstack/react-query, @playlive/fundraiser-data, @playlive/tiltify-core (types only).

Example

import { QueryClientProvider } from "@tanstack/react-query";
import { configure } from "@playlive/fundraiser-data/config";
import {
  makeQueryClient,
  useCampaign,
  useInfiniteDonations,
} from "@playlive/react-query";

configure({ tiltifyProxyUrl: "https://proxy.example" });
const qc = makeQueryClient();

function App() {
  return (
    <QueryClientProvider client={qc}>
      <Overlay id="abc-123" />
    </QueryClientProvider>
  );
}

function Overlay({ id }: { id: string }) {
  const campaign = useCampaign({ charityType: "tiltify", id });
  const donations = useInfiniteDonations({ charityType: "tiltify", campaignId: id });
  if (campaign.isLoading) return "Loading…";
  return <pre>{JSON.stringify({ campaign: campaign.data, pages: donations.data?.pages.length })}</pre>;
}

Interfaces

GiftsThatGiveMilestoneItem
HookRefetchOptions
LeaderboardRow
UseAlertsQueueOptions
UseAlertsQueueParams
UseAlertsQueueResult
UseCampaignChildrenParams
UseCampaignGiftsThatGiveMilestonesParams
UseCampaignGiftsThatGiveMilestonesResult
UseCampaignParams
UseCampaignRulesetsParams
UseCampaignRulesetsStateParams
UseCampaignRulesetsStateResult
UseCampaignsResult
UseCauseParams
UseCurrentEventsParams
UseDonationTrainCommonTrainsParams
UseDonationTrainHighRateDonorsParams
UseDonationTrainsParams
UseDonationTrainStateParams
UseDonationTrainStateResult
UseDonorSpotlightOverviewParams
UseEventCampaignsParams
UseFetchOptions
UseFetchResult
UseFlattenedDonationsParams
UseFundraisingEventMilestonesParams
UseFundraisingEventParams
UseGiftsThatGiveMilestonesParams
UseInfiniteDonationsParams
UseInfiniteDonationsResult
UseLeaderboardExclusionsParams
UseLeaderboardExclusionsResult
UseLeaderboardParams
UseLeaderboardResult
UseLeaderboardWithExclusionsParams
UseLifetimeRaisedParams
UseMutationResult
UsePreviousYearTotalsParams
UseScheduleBlockRaisedParams
UseTeamParams
UseTiltifyLeaderboardParams
UseTiltifyLeaderboardResult
UseTiltifyUserCampaignsParams
UseUserParams

Variables

DEFAULT_ALERT_DURATIONS_MS
DEFAULT_QUERY_OPTIONS
KNOWN_URLS
PACKAGE_NAME

Functions

makeQueryClient
useAlertsQueue
useCampaign
useCampaignAmounts
useCampaignFundraisingEventAmounts
useCampaignGiftsThatGiveMilestones
useCampaignRulesets
useCampaignRulesetsState
useCampaigns
useCause
useCreateCampaignRuleset
useCurrentEvents
useDeleteRuleset
useDonationsReducer
useDonationTrainCommonTrains
useDonationTrainHighRateDonors
useDonationTrains
useDonationTrainState
useDonorSpotlightOverview
useEventCampaigns
useFlattenedDonations
useFundraisingEvent
useFundraisingEventMilestones
useGiftsThatGiveMilestones
useInfiniteDonations
useLeaderboard
useLeaderboardExclusions
useLeaderboardWithExclusions
useLifetimeRaised
useMilestones
usePolls
usePreviousYearTotals
useProcessDonationsForTrains
useRefreshTrainStatus
useRewards
useSchedule
useScheduleBlockRaised
useTargets
useTeam
useTestDonations
useTiltifyLeaderboard
useTiltifyUserAndTeamCampaigns
useTiltifyUserCampaigns
useUpdateRuleset
useUpdateTrainVisibility
useUser

@playlive/react-query

Example

Interfaces

Variables

Functions

Settings

On This Page