takeHydrationValue

Removes and returns the value the server render wrote under key with getHydrationWriter().write(key, value), or undefined when the page carries none (or it was already taken). A written promise arrives as "pending" until its settlement streams in, then as "resolved" or "rejected". Readable before hydrate() runs and after hydration has ended. Server: undefined.

The page's values live on globalThis._$HY.r; a test seeds them with globalThis._$HY = { r: { "sq:key": value } }.

Import

import { takeHydrationValue } from "@solidjs/web";

Type signature

function takeHydrationValue<T = unknown>(
  key: string
): HydrationValue<T> | undefined;

Parameters

key

• Type: string

Learn more

• Controlling hydration
• Rendering and SSR
• Choose a rendering mode

Related types

HydrationValue

A keyed value taken from the hydration registry (takeHydrationValue).

type HydrationValue<T = unknown> =
  | { status: "resolved"; value: T }
  | { status: "rejected"; error: unknown }
  | { status: "pending"; promise: Promise<T> };