Blame: docs/framework/react/reference/queryOptions.md - TanStack/query

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 1 TypeScript

Normal View History Raw

docs: query options 2023-12-04 14:16:18 +01:00			`---`
			`id: queryOptions`
			`title: queryOptions`
			`---`

			```tsx
			`queryOptions({`
			`queryKey,`
docs: Run prettier on docs directory (#6595) 2023-12-27 08:04:23 +11:00			`...options,`
docs: query options 2023-12-04 14:16:18 +01: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 generally pass everything to `queryOptions` that you can also pass to [`useQuery`](../useQuery.md). Some options will have no effect when then forwarded to a function like `queryClient.prefetchQuery`, but TypeScript will still be fine with those excess properties.
docs: query options 2023-12-04 14:16:18 +01:00
			- `queryKey: QueryKey`
			`- Required`
			`- The query key to generate options for.`
feat: add support for `React.use()` (#7988) * let’s do it again * fix test group * maybe * mkay * cool * rm console.logs * mkay * mkay * fix(vue-query): invalidate queries immediately after calling `invalidateQueries` (#7930) * fix(vue-query): invalidate queries immediately after call `invalidateQueries` * chore: recovery code comments * release: v5.53.2 * docs(vue-query): update SSR guide for nuxt2 (#8001) * docs: update SSR guide for nuxt2 * ci: apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * thenable * mkay * Update packages/react-query/src/__tests__/useQuery.test.tsx * mkay * mkay * faster and more consistent * mkay * mkay * mkay * mkay * mkay * fix unhandled rejections * more * more * mkay * fix more * fixy * cool * Update packages/react-query/package.json * fix: track data property if `promise` is tracked if users use the `promise` returned from useQuery, they are actually interested in the `data` it unwraps to. Since the promise doesn't change when data resolves, we would likely miss a re-render * Revert "fix: track data property if `promise` is tracked" This reverts commit d1184babd1ba570da09798cad0e8613b7c5b69c8. * add test case that @tkdodo was concerned about * tweak * mkay * add `useInfiniteQuery()` test * consistent testing * better test * rm comment * test resetting errror boundary * better test * cool * cool * more test * mv cleanup * mkay * some more things * add fixme * fix types * wat * fixes * revert * fix * colocating doesn’t workkk * mkay * mkay * might work * more test * cool * i don’t know hwat i’m doing * mocky * lint * space * rm log * setIsServer * mkay * ffs * remove unnecessary stufffff * tweak more * just naming and comments * tweak * fix: use fetchOptimistic util instead of observer.fetchOptimistic * refactor: make sure to only trigger fetching during render if we really have no cache entry yet * fix: move the `isNewCacheEntry` check before observer creation * chore: avoid rect key warnings * fix: add an `updateResult` for all observers to finalize currentThenable * chore: logs during suspense errors * fix: empty catch * feature flag * add comment * simplify * omit from suspense * feat flag * more tests * test: scope experimental_promise to useQuery().promise tests * refactor: rename to experimental_prefetchInRender * test: more tests * test: more cancelation * fix cancellation * make it work * tweak comment * Update packages/react-query/src/useBaseQuery.ts * simplify code a bit * Update packages/query-core/src/queryObserver.ts * refactor: move experimental_prefetchInRender check until after the early bail-out * fix: when cancelled, the promise should stay pending * test: disabled case * chore: no idea what's going on * refactor: delete unnecessary check * revert refactor i did for cancellation when we wanted it to `throw` * add docs * align * tweak * Update docs/reference/QueryClient.md * Update docs/framework/react/reference/queryOptions.md --------- Co-authored-by: Alex Liu <dsa1314@gmail.com> Co-authored-by: Tanner Linsley <tannerlinsley@users.noreply.github.com> Co-authored-by: Damian Osipiuk <osipiukd+git@gmail.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc> 2024-10-01 11:39:37 -04:00			- `experimental_prefetchInRender?: boolean`
			`- Optional`
			- Defaults to `false`
			- When set to `true`, queries will be prefetched during render, which can be useful for certain optimization scenarios
			- Needs to be turned on for the experimental `useQuery().promise` functionality