mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* docs(query-core): add JSDoc across the package and expose it in generated reference docs * docs(config.json): add sidebar entries for newly generated query-core reference docs * docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc * docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference * docs(query-core): regenerate reference docs after merging main * docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type * fix(query-devtools): drop unnecessary 'query-core' project reference * docs(query-core): document missing default values and normalize 'Defaults to' spacing * docs(query-core): fix 'environmentManager' JSDoc example
1.6 KiB
1.6 KiB
| id | title |
|---|---|
| HydrationBoundary | HydrationBoundary |
function HydrationBoundary(__namedParameters): ReactElement<unknown, string | JSXElementConstructor<any>>;
Defined in: packages/react-query/src/HydrationBoundary.tsx:86
HydrationBoundary adds a previously dehydrated state into the queryClient that would be returned by
useQueryClient(). If the client already contains data, the new queries will be intelligently merged based on
update timestamp.
Note: Only queries can be dehydrated with an HydrationBoundary.
Parameters
__namedParameters
Returns
ReactElement<unknown, string | JSXElementConstructor<any>>
The provided children, rendered unconditionally. New queries in state are hydrated into the
cache during render; for queries already in the cache, only newer dehydrated data is hydrated, in an effect
after commit.
Examples
import { HydrationBoundary } from '@tanstack/react-query'
function App() {
return <HydrationBoundary state={dehydratedState}>...</HydrationBoundary>
}
Server-side prefetch handed off to the client via dehydrate:
import { HydrationBoundary, dehydrate, noop } from '@tanstack/react-query'
async function ServerComponent() {
const queryClient = getQueryClient()
await queryClient
.query({
queryKey: ['posts'],
queryFn: fetchPosts,
})
.catch(noop)
return (
<HydrationBoundary state={dehydrate(queryClient)}>
<Posts />
</HydrationBoundary>
)
}