Morph MORPH
SIGN IN SIGN UP
TanStack / query UNCLAIMED

🤖 Powerful asynchronous state management, server-state utilities and data fetching for the web. TS/JS, React Query, Solid Query, Svelte Query and Vue Query.

0 0 0 TypeScript
Normal View History Raw
feat(react-query): usePrefetchQuery (#7582) * feat: usePrefetchQuery * refactor: switch to actual prefetching * refactor: remove ensureInfiniteQueryData function will do in a separate PR * chore: add tests for usePrefetchQuery and usePrefetchInfiniteQuery (#7586) * chore: add tests for usePrefetchQuery and usePrefetchInfiniteQuery * chore: update tests to assert the alternative spy is not called * chore: add some new tests * chore: remove it.only whoops * chore: call mockClear after fetching * chore: improve waterfall test by asserting fallback calls instead of loading node query * chore: improve code repetition * chore: add some generics to helper functions * usePrefetchQuery type tests and docs (#7592) * chore: add type tests and docs * chore: update hooks to use FetchQueryOptions and FetchInfiniteQueryOptions * chore: update tests * chore: update docs * chore: remove .md extension from link * chore: add unknown default value to TQueryFnData * Apply suggestions from code review --------- Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> * Apply suggestions from code review Co-authored-by: Fredrik Höglund <fredrik.hoglund@gmail.com> * chore: fix types in tests * chore: add new tests (#7614) * chore: add new tests * Apply suggestions from code review --------- Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> --------- Co-authored-by: Bruno Lopes <88719327+brunolopesr@users.noreply.github.com> Co-authored-by: Fredrik Höglund <fredrik.hoglund@gmail.com>
2024-06-25 14:25:28 +02:00
---
id: usePrefetchQuery
title: usePrefetchQuery
---
```tsx
docs: Remove the variable assignment from example code (#7623) * Remove the variable assignment from example code * remove variable assignment in prefetch query docs --------- Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
2024-06-27 06:48:18 -06:00
usePrefetchQuery(options)
feat(react-query): usePrefetchQuery (#7582) * feat: usePrefetchQuery * refactor: switch to actual prefetching * refactor: remove ensureInfiniteQueryData function will do in a separate PR * chore: add tests for usePrefetchQuery and usePrefetchInfiniteQuery (#7586) * chore: add tests for usePrefetchQuery and usePrefetchInfiniteQuery * chore: update tests to assert the alternative spy is not called * chore: add some new tests * chore: remove it.only whoops * chore: call mockClear after fetching * chore: improve waterfall test by asserting fallback calls instead of loading node query * chore: improve code repetition * chore: add some generics to helper functions * usePrefetchQuery type tests and docs (#7592) * chore: add type tests and docs * chore: update hooks to use FetchQueryOptions and FetchInfiniteQueryOptions * chore: update tests * chore: update docs * chore: remove .md extension from link * chore: add unknown default value to TQueryFnData * Apply suggestions from code review --------- Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> * Apply suggestions from code review Co-authored-by: Fredrik Höglund <fredrik.hoglund@gmail.com> * chore: fix types in tests * chore: add new tests (#7614) * chore: add new tests * Apply suggestions from code review --------- Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> --------- Co-authored-by: Bruno Lopes <88719327+brunolopesr@users.noreply.github.com> Co-authored-by: Fredrik Höglund <fredrik.hoglund@gmail.com>
2024-06-25 14:25:28 +02:00
```
**Options**
docs: fix links commit 113eb6ba963534fe80b3e96193d767bf769c8bff Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 23:16:11 2025 -0600 docs: fix: only transform generated reference commit d1d084ed9026e31ba746e1bb87d5c19183a7d148 Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 23:12:07 2025 -0600 docs: fix broken links commit 0df59ea7d8afb16be86ae917fc46900b6e999351 Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 15:54:19 2025 -0600 fix: rewrite type doc links to be directory-relative commit 81e4c71f1c9250005f164b7e585837ee0ad14e23 Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 15:14:51 2025 -0600 fix: initial fix for ./ => ../
2025-05-24 00:47:55 -06:00
You can pass everything to `usePrefetchQuery` that you can pass to [`queryClient.prefetchQuery`](../../../../reference/QueryClient.md#queryclientprefetchquery). Remember that some of them are required as below:
feat(react-query): usePrefetchQuery (#7582) * feat: usePrefetchQuery * refactor: switch to actual prefetching * refactor: remove ensureInfiniteQueryData function will do in a separate PR * chore: add tests for usePrefetchQuery and usePrefetchInfiniteQuery (#7586) * chore: add tests for usePrefetchQuery and usePrefetchInfiniteQuery * chore: update tests to assert the alternative spy is not called * chore: add some new tests * chore: remove it.only whoops * chore: call mockClear after fetching * chore: improve waterfall test by asserting fallback calls instead of loading node query * chore: improve code repetition * chore: add some generics to helper functions * usePrefetchQuery type tests and docs (#7592) * chore: add type tests and docs * chore: update hooks to use FetchQueryOptions and FetchInfiniteQueryOptions * chore: update tests * chore: update docs * chore: remove .md extension from link * chore: add unknown default value to TQueryFnData * Apply suggestions from code review --------- Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> * Apply suggestions from code review Co-authored-by: Fredrik Höglund <fredrik.hoglund@gmail.com> * chore: fix types in tests * chore: add new tests (#7614) * chore: add new tests * Apply suggestions from code review --------- Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> --------- Co-authored-by: Bruno Lopes <88719327+brunolopesr@users.noreply.github.com> Co-authored-by: Fredrik Höglund <fredrik.hoglund@gmail.com>
2024-06-25 14:25:28 +02:00
- `queryKey: QueryKey`
- **Required**
- The query key to prefetch during render
- `queryFn: (context: QueryFunctionContext) => Promise<TData>`
docs: fix links commit 113eb6ba963534fe80b3e96193d767bf769c8bff Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 23:16:11 2025 -0600 docs: fix: only transform generated reference commit d1d084ed9026e31ba746e1bb87d5c19183a7d148 Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 23:12:07 2025 -0600 docs: fix broken links commit 0df59ea7d8afb16be86ae917fc46900b6e999351 Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 15:54:19 2025 -0600 fix: rewrite type doc links to be directory-relative commit 81e4c71f1c9250005f164b7e585837ee0ad14e23 Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 15:14:51 2025 -0600 fix: initial fix for ./ => ../
2025-05-24 00:47:55 -06:00
- **Required, but only if no default query function has been defined** See [Default Query Function](../../guides/default-query-function.md) for more information.
feat(react-query): usePrefetchQuery (#7582) * feat: usePrefetchQuery * refactor: switch to actual prefetching * refactor: remove ensureInfiniteQueryData function will do in a separate PR * chore: add tests for usePrefetchQuery and usePrefetchInfiniteQuery (#7586) * chore: add tests for usePrefetchQuery and usePrefetchInfiniteQuery * chore: update tests to assert the alternative spy is not called * chore: add some new tests * chore: remove it.only whoops * chore: call mockClear after fetching * chore: improve waterfall test by asserting fallback calls instead of loading node query * chore: improve code repetition * chore: add some generics to helper functions * usePrefetchQuery type tests and docs (#7592) * chore: add type tests and docs * chore: update hooks to use FetchQueryOptions and FetchInfiniteQueryOptions * chore: update tests * chore: update docs * chore: remove .md extension from link * chore: add unknown default value to TQueryFnData * Apply suggestions from code review --------- Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> * Apply suggestions from code review Co-authored-by: Fredrik Höglund <fredrik.hoglund@gmail.com> * chore: fix types in tests * chore: add new tests (#7614) * chore: add new tests * Apply suggestions from code review --------- Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> --------- Co-authored-by: Bruno Lopes <88719327+brunolopesr@users.noreply.github.com> Co-authored-by: Fredrik Höglund <fredrik.hoglund@gmail.com>
2024-06-25 14:25:28 +02:00
**Returns**
docs: fix links commit 113eb6ba963534fe80b3e96193d767bf769c8bff Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 23:16:11 2025 -0600 docs: fix: only transform generated reference commit d1d084ed9026e31ba746e1bb87d5c19183a7d148 Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 23:12:07 2025 -0600 docs: fix broken links commit 0df59ea7d8afb16be86ae917fc46900b6e999351 Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 15:54:19 2025 -0600 fix: rewrite type doc links to be directory-relative commit 81e4c71f1c9250005f164b7e585837ee0ad14e23 Author: Tanner Linsley <tannerlinsley@gmail.com> Date: Fri May 23 15:14:51 2025 -0600 fix: initial fix for ./ => ../
2025-05-24 00:47:55 -06:00
The `usePrefetchQuery` does not return anything, it should be used just to fire a prefetch during render, before a suspense boundary that wraps a component that uses [`useSuspenseQuery`](../useSuspenseQuery.md).
Reference in New Issue Copy Permalink