HydrationBoundaryProps

Defined in: preact-query/src/HydrationBoundary.tsx:17

The props accepted by HydrationBoundary.

Properties#

children?#

optional children: ComponentChildren;

Defined in: preact-query/src/HydrationBoundary.tsx:37

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: preact-query/src/HydrationBoundary.tsx:25

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

Type Declaration#

defaultOptions?#

optional defaultOptions: OmitKeyof<{
}, "mutations">;

queryClient?#

optional queryClient: QueryClient;

Defined in: preact-query/src/HydrationBoundary.tsx:41

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

state#

state: DehydratedState | null | undefined;

Defined in: preact-query/src/HydrationBoundary.tsx:21

The state to hydrate.