2.0 KiB
id, title
| 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.