dehydrate · Next.js server API

function dehydrate<TSchema>(options): HydrationSnapshot<TSchema>;

Reads serializable snapshots from hydratable entities declared in a schema.

Use this on the server side before crossing into a Client Component. Only the returned snapshot should cross the boundary, not the container or service instances themselves.

Type Parameters

Type Parameter
TSchema extends Readonly<Record<string, Token<Hydratable<Serializable>>>>

Parameters

Parameter	Type	Description
options	DehydrateOptions<TSchema>	Container and schema describing state to serialize.

Returns

HydrationSnapshot<TSchema>

A serializable snapshot inferred from the schema.

Example

const hydration = { user: USER_STATE };
const snapshot = dehydrate({
  container: getRequestContainer(),
  schema: hydration,
});

Throws

Error when the schema contains a missing token.