Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 2.69 KB

prerendering.md

File metadata and controls

76 lines (50 loc) · 2.69 KB
description Prerender pages at deploy time so the first visitor receives cached HTML.
outline deep

Edge Prerendering

Prerender pages at deploy time so the first visitor receives cached HTML.

Static pages (no params)

Export prerender = true from the companion .server.ts file:

// pages/about.server.ts
export const prerender = true;

Pages without dynamic params do not need getPrerenderPaths().

Dynamic pages (with params)

For a dynamic page, export getPrerenderPaths() to choose which paths to render. Annotate its return type with PageParams so TypeScript checks the parameter names:

// pages/blog/[slug].server.ts
import type { PageParams } from 'void/routes';

export const prerender = true;

export async function getPrerenderPaths(): Promise<PageParams<'/blog/[slug]'>[]> {
  return [{ slug: 'hello-world' }, { slug: 'getting-started' }];
}

Return an object for each path, with every required parameter. Values can be strings or numbers; Void URL-encodes them. Use a catch-all page such as pages/docs/[...slug] for values containing /, for example { slug: 'guides/intro' }.

The type annotation is required for TypeScript to check the keys. At deployment, Void reports invalid entries with their server filename and index.

Custom SSR

In custom SSR mode (src/main.ssr.ts), export getPrerenderPaths() at the top level. Since there's no file-based routing, return full path strings:

// src/main.ssr.ts
export const prerender = true;

export async function getPrerenderPaths(): Promise<string[]> {
  return ['/', '/about', '/blog/hello-world'];
}

Relationship to revalidation

Setting routing.isr: false in void.config.ts disables ISR and this edge-prerendering behavior, including per-page exports. It does not disable build-time HTML generation with output: "static".

Prerendered pages default to a one-year revalidate TTL. Deploys clear the ISR cache.

Override the TTL per page:

// pages/about.server.ts
export const prerender = true;
export const revalidate = 3600;

If the cached page expires before your next deploy, the next request waits for a fresh render.

Behavior details

  • Prerender happens once per deployment, before traffic is routed to the new version. Prerendered pages are cached at the edge.
  • Only paths with a positive revalidate TTL are prerendered (TTL 0 is skipped).
  • Prerender failures are logged but never block the deploy. The page will render on the first request as usual.