AstroPrerenderer Type — astro Architecture

Source Code

packages/astro/src/types/public/integrations.ts lines 173–194

export interface AstroPrerenderer {
	name: string;
	/**
	 * Called once before prerendering starts. Use for setup like starting a preview server.
	 */
	setup?: () => Promise<void>;
	/**
	 * Returns pathnames with their routes to prerender. The route is included to avoid
	 * needing to re-match routes later, which can be incorrect due to route priority.
	 */
	getStaticPaths: () => Promise<PathWithRoute[]>;
	/**
	 * Renders a single page. Called by Astro for each path returned by getStaticPaths.
	 * @param request - The request to render
	 * @param options - Render options including routeData
	 */
	render: (request: Request, options: { routeData: RouteData }) => Promise<Response>;
	/**
	 * Called after all pages are prerendered. Use for cleanup like stopping a preview server.
	 */
	teardown?: () => Promise<void>;
}