snapshot of https://github.com/TanStack/query.git (main, 2026-09-16; blobs > 131072B omitted)
This commit is contained in:
61
docs/framework/svelte/reference/functions/useHydrate.md
Normal file
61
docs/framework/svelte/reference/functions/useHydrate.md
Normal file
@@ -0,0 +1,61 @@
|
||||
---
|
||||
id: useHydrate
|
||||
title: useHydrate
|
||||
---
|
||||
|
||||
```ts
|
||||
function useHydrate(
|
||||
state?,
|
||||
options?,
|
||||
queryClient?): void;
|
||||
```
|
||||
|
||||
Defined in: [packages/svelte-query/src/useHydrate.ts:33](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useHydrate.ts#L33)
|
||||
|
||||
Adds a previously dehydrated `state` into the `queryClient` (from the nearest context, or the one
|
||||
passed explicitly). If the client already contains data, the new queries will be intelligently merged based
|
||||
on update timestamp. `HydrationBoundary` wraps this — use it directly only if you need to hydrate from your
|
||||
own component instead.
|
||||
|
||||
## Parameters
|
||||
|
||||
### state?
|
||||
|
||||
`unknown`
|
||||
|
||||
The dehydrated state to hydrate into the cache, as produced by `dehydrate`.
|
||||
|
||||
### options?
|
||||
|
||||
[`HydrateOptions`](../interfaces/HydrateOptions.md)
|
||||
|
||||
[HydrateOptions](../interfaces/HydrateOptions.md) to control the hydration.
|
||||
|
||||
### queryClient?
|
||||
|
||||
[`QueryClient`](../classes/QueryClient.md)
|
||||
|
||||
Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will
|
||||
be used.
|
||||
|
||||
## Returns
|
||||
|
||||
`void`
|
||||
|
||||
## Example
|
||||
|
||||
Server-side prefetch handed off to the client via `dehydrate` — `dehydratedState` would typically come
|
||||
from a server load function that prefetched with `queryClient.query` and called `dehydrate(queryClient)`:
|
||||
```svelte
|
||||
<script lang="ts">
|
||||
import { HydrationBoundary } from '@tanstack/svelte-query'
|
||||
import type { DehydratedState } from '@tanstack/svelte-query'
|
||||
import Posts from './Posts.svelte'
|
||||
|
||||
let { dehydratedState }: { dehydratedState: DehydratedState } = $props()
|
||||
</script>
|
||||
|
||||
<HydrationBoundary state={dehydratedState}>
|
||||
<Posts />
|
||||
</HydrationBoundary>
|
||||
```
|
||||
Reference in New Issue
Block a user