tanstack-query

TanStack Query Reference

TanStack Query (@tanstack/react-queryA skill distilled from the official v5 documentation. Depending on the user's task, read the appropriate README.md and follow it to the individual files.

Directory structure

skills/tanstack-query/
  SKILL.md
  references/
    getting-started/
      README.md
      overview.md
      installation.md
      quick-start.md
      devtools.md
      typescript.md
      graphql.md
      react-native.md
      comparison.md
    guides/
      README.md
      important-defaults.md
      queries.md
      query-keys.md
      query-functions.md
      query-options.md
      network-mode.md
      parallel-queries.md
      dependent-queries.md
      background-fetching-indicators.md
      window-focus-refetching.md
      polling.md
      disabling-queries.md
      query-retries.md
      paginated-queries.md
      infinite-queries.md
      initial-query-data.md
      placeholder-query-data.md
      mutations.md
      query-invalidation.md
      invalidations-from-mutations.md
      updates-from-mutation-responses.md
      optimistic-updates.md
      query-cancellation.md
      scroll-restoration.md
      filters.md
      request-waterfalls.md
      prefetching.md
      ssr.md
      advanced-ssr.md
      caching.md
      render-optimizations.md
      default-query-function.md
      suspense.md
      testing.md
      does-this-replace-client-state.md
      migrating-to-v5.md
      migrating-to-react-query-4.md
      migrating-to-react-query-3.md
    api/
      README.md
      query-client.md
      query-cache.md
      mutation-cache.md
      query-observer.md
      infinite-query-observer.md
      queries-observer.md
      streamed-query.md
      focus-manager.md
      online-manager.md
      notify-manager.md
      environment-manager.md
      timeout-manager.md
      use-query.md
      use-queries.md
      use-infinite-query.md
      use-mutation.md
      use-is-fetching.md
      use-is-mutating.md
      use-mutation-state.md
      use-suspense-query.md
      use-suspense-infinite-query.md
      use-suspense-queries.md
      query-client-provider.md
      use-query-client.md
      query-options.md
      infinite-query-options.md
      mutation-options.md
      use-prefetch-query.md
      use-prefetch-infinite-query.md
      query-error-reset-boundary.md
      use-query-error-reset-boundary.md
      hydration.md
    plugins/
      README.md
      eslint-plugin-query.md
      exhaustive-deps.md
      stable-query-client.md
      no-rest-destructuring.md
      no-unstable-deps.md
      infinite-query-property-order.md
      no-void-query-fn.md
      mutation-property-order.md
      prefer-query-options.md
      persist-query-client.md
      create-sync-storage-persister.md
      create-async-storage-persister.md
      broadcast-query-client.md
      create-persister.md
  samples/
    README.md
    basic-query.md
    dependent-queries.md
    pagination.md
    infinite-scroll.md
    mutations-invalidation.md
    optimistic-update.md
    prefetching.md
    ssr-hydration.md
    suspense.md
    offline-persist.md
    testing.md

Exploration procedure

Derive the category from the task, and identify the target page in the category's README.md:

1. Find the category corresponding to the task in the mapping table below
2. For that category references/{category}/README.md Refer to and identify the target page
3. Read the .md of the relevant page to check the details

Task → Category Mapping

Task	Category	Reference README
Want to know about introduction, installation, Quick Start, Devtools, TypeScript configuration	getting-started	references/getting-started/README.md
Want to know the differences from SWR / Apollo Client / RTK Query, and using with GraphQL / React Native	getting-started	references/getting-started/README.md
Want to know implementation policies for query key design, parallel/dependent queries, pagination, and infinite scrolling	guides	references/guides/README.md
Want to know the behavior of mutations, cache invalidation, optimistic updates, and cancellation	guides	references/guides/README.md
Want to know SSR / hydration, Suspense integration, testing policies, and v5 migration differences	guides	references/guides/README.md
useQuery / useMutation / useInfiniteQuery Want to know the signatures and options of hooks such as	api	references/api/README.md
QueryClient / QueryCache / QueryObserver Want to know the API of core classes such as	api	references/api/README.md
queryOptions / infiniteQueryOptions / mutationOptions / hydration Want to know the types and functions of	api	references/api/README.md
eslint-plugin-query Want to know each rule of	plugins	references/plugins/README.md
persistQueryClient / Persister / broadcastQueryClient Want to know cache persistence with	plugins	references/plugins/README.md
Want to know typical usage	samples	samples/README.md
Want to know examples of rolling back optimistic updates and implementing hydration in SSR	samples	samples/README.md
Want to know examples of offline cache persistence and hook test implementation	samples	samples/README.md