addServerRenderer() — astro Function Reference

Architecture documentation for the addServerRenderer() function in index.ts from the astro codebase.

Function typescript CoreAstro RenderingEngine calls 1

Entity Profile

CoreAstro→ RenderingEngine→ addServerRenderer() — astro Function Reference

Dependency Diagram

graph TD
  db473761_f4ce_cb75_4308_e319cad682b5["addServerRenderer()"]
  cb9f7e72_0a2c_f337_8c0f_3a16cbafeab3["experimental_AstroContainer"]
  db473761_f4ce_cb75_4308_e319cad682b5 -->|defined in| cb9f7e72_0a2c_f337_8c0f_3a16cbafeab3
  39a8e29a_e166_5c3c_6e0a_13a0a267d2d2["isNamedRenderer()"]
  db473761_f4ce_cb75_4308_e319cad682b5 -->|calls| 39a8e29a_e166_5c3c_6e0a_13a0a267d2d2
  style db473761_f4ce_cb75_4308_e319cad682b5 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/container/index.ts lines 362–385

	public addServerRenderer(options: AddServerRenderer): void {
		const { renderer } = options;
		if (!renderer.check || !renderer.renderToStaticMarkup) {
			throw new Error(
				"The renderer you passed isn't valid. A renderer is usually an object that exposes the `check` and `renderToStaticMarkup` functions.\n" +
					"Usually, the renderer is exported by a /server.js entrypoint e.g. `import renderer from '@astrojs/react/server.js'`",
			);
		}
		if (isNamedRenderer(renderer)) {
			this.#pipeline.manifest.renderers.push({
				name: renderer.name,
				ssr: renderer,
			});
		} else if ('name' in options) {
			this.#pipeline.manifest.renderers.push({
				name: options.name,
				ssr: renderer,
			});
		} else {
			throw new Error(
				'The renderer name must be provided when adding a server renderer that is not a named renderer.',
			);
		}
	}