0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/react/reference/interfaces/HydrationBoundaryProps.md
Wonsuk Choi e57f8163b1
docs(query-core): add JSDoc across the package and expose it in generated reference docs (#11438)
* 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
2026-09-07 18:22:38 +02:00

2 KiB

id title
HydrationBoundaryProps HydrationBoundaryProps

Defined in: packages/react-query/src/HydrationBoundary.tsx:16

The props accepted by HydrationBoundary.

Properties

children?

optional children: ReactNode;

Defined in: packages/react-query/src/HydrationBoundary.tsx:36

The components to render — always rendered unconditionally, not gated on hydration. New queries are hydrated into the cache during render; for queries that already exist in the cache, only newer dehydrated data is hydrated, and that happens in an effect after commit, so children may render briefly before it lands.


options?

optional options: OmitKeyof<HydrateOptions, "defaultOptions"> & object;

Defined in: packages/react-query/src/HydrationBoundary.tsx:24

Optional. Note: unlike hydrate, mutations cannot be set here.

Type Declaration

defaultOptions?
optional defaultOptions: OmitKeyof<{
  deserializeData?: TransformerFn;
  mutations?: MutationOptions<unknown, Error, unknown, unknown>;
  queries?: QueryOptions<unknown, Error, unknown, readonly unknown[], never>;
}, "mutations">;

queryClient?

optional queryClient: QueryClient;

Defined in: packages/react-query/src/HydrationBoundary.tsx:40

Use this to use a custom QueryClient. Otherwise, the one from the nearest context will be used.


state

state: DehydratedState | null | undefined;

Defined in: packages/react-query/src/HydrationBoundary.tsx:20

The state to hydrate.