getRoutePrerenderOption() — astro Function Reference

Architecture documentation for the getRoutePrerenderOption() function in prerender.ts from the astro codebase.

Function typescript CoreAstro RoutingSystem

Entity Profile

CoreAstro→ RoutingSystem→ getRoutePrerenderOption() — astro Function Reference

Dependency Diagram

graph TD
  b3d05f05_47ef_3a80_997a_1f8d606da97c["getRoutePrerenderOption()"]
  38e74a42_461a_7851_4408_04bbe406277e["prerender.ts"]
  b3d05f05_47ef_3a80_997a_1f8d606da97c -->|defined in| 38e74a42_461a_7851_4408_04bbe406277e
  style b3d05f05_47ef_3a80_997a_1f8d606da97c fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/core/routing/manifest/prerender.ts lines 9–32

export async function getRoutePrerenderOption(
	content: string,
	route: RouteData,
	settings: AstroSettings,
	logger: Logger,
) {
	// Check if the route is pre-rendered or not
	const match = PRERENDER_REGEX.exec(content);
	if (match) {
		route.prerender = match[1] === 'true';
		if (route.redirectRoute) {
			route.redirectRoute.prerender = match[1] === 'true';
		}
	}

	await runHookRouteSetup({ route, settings, logger });

	// If not explicitly set, default to the global setting
	if (typeof route.prerender === undefined) {
		route.prerender = getPrerenderDefault(settings.config);
	}

	if (!route.prerender) settings.buildOutput = 'server';
}