serializeObject() — astro Function Reference

Architecture documentation for the serializeObject() function in serialize.ts from the astro codebase.

Function typescript CoreAstro RenderingEngine calls 1 called by 2

Entity Profile

CoreAstro→ RenderingEngine→ serializeObject() — astro Function Reference

Dependency Diagram

graph TD
  8d7cde9f_83f1_0783_c6af_f3a4c88f86d5["serializeObject()"]
  503a0de8_cf3d_458a_44c0_c9f295739fb6["serialize.ts"]
  8d7cde9f_83f1_0783_c6af_f3a4c88f86d5 -->|defined in| 503a0de8_cf3d_458a_44c0_c9f295739fb6
  1502697a_a04e_810c_bd56_b25bd832d1c5["convertToSerializedForm()"]
  1502697a_a04e_810c_bd56_b25bd832d1c5 -->|calls| 8d7cde9f_83f1_0783_c6af_f3a4c88f86d5
  82d14e61_ae52_88bc_461b_0f4191004194["serializeProps()"]
  82d14e61_ae52_88bc_461b_0f4191004194 -->|calls| 8d7cde9f_83f1_0783_c6af_f3a4c88f86d5
  1502697a_a04e_810c_bd56_b25bd832d1c5["convertToSerializedForm()"]
  8d7cde9f_83f1_0783_c6af_f3a4c88f86d5 -->|calls| 1502697a_a04e_810c_bd56_b25bd832d1c5
  style 8d7cde9f_83f1_0783_c6af_f3a4c88f86d5 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/runtime/server/serialize.ts lines 37–55

function serializeObject(
	value: Record<any, any>,
	metadata: AstroComponentMetadata | Record<string, any> = {},
	parents = new WeakSet<any>(),
): Record<any, any> {
	if (parents.has(value)) {
		throw new Error(`Cyclic reference detected while serializing props for <${metadata.displayName} client:${metadata.hydrate}>!

Cyclic references cannot be safely serialized for client-side usage. Please remove the cyclic reference.`);
	}
	parents.add(value);
	const serialized = Object.fromEntries(
		Object.entries(value).map(([k, v]) => {
			return [k, convertToSerializedForm(v, metadata, parents)];
		}),
	);
	parents.delete(value);
	return serialized;
}