0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/examples/react/default-query-function/README.md
Wonsuk Choi 70441f460d
docs(examples): rewrite the READMEs, add the framework or router to example titles, and rename examples to '<feature>-<framework>' (#12583)
* docs(examples): describe each example in its README with a summary, the framework it is built with, how it works and the npm commands

* docs(examples): add the framework or router to the README heading and page title of examples that have variants

* docs(examples/react): rename the Next.js examples to '<feature>-nextjs-<pages|app>-router'

* docs(examples/react): update package names, docs links and labels, and the lockfile for the renamed Next.js examples

* docs(examples): rename 'svelte/sveltekit', 'solid/solid-start-streaming' and 'angular/router' to '<feature>-<framework>'

* docs(examples): correct README details on staleness, hydration, 'hasMore', streaming and dependent queries, and prefetch on 'focusin' in 'vue/prefetching-nuxt4'
2026-11-12 16:58:15 +09:00

781 B

TanStack React Query Default Query Function Example

Sets a default queryFn on the QueryClient that builds the request URL from the query key, so each query only passes a queryKey.

How it works

  • src/index.tsx defines defaultQueryFn, which fetches https://jsonplaceholder.typicode.com${queryKey[0]}, and registers it as defaultOptions.queries.queryFn on the QueryClient.
  • In src/index.tsx, Posts calls useQuery<Array<Post>>({ queryKey: ['/posts'] }) and Post calls useQuery<Post>({ queryKey: [`/posts/${postId}`], enabled: !!postId }), without a queryFn.
  • In src/index.tsx, the list marks a post as visited when queryClient.getQueryData([`/posts/${post.id}`]) returns cached data.

To run this example:

  • npm install
  • npm run dev