Skip to main content

Interface: StaticExportApp

Defined in: static.ts:15

One app's crawl configuration, for exporting a multi-app project in a single call.

Properties​

appDir​

appDir: string

Defined in: static.ts:17

Filesystem path to this app's directory, relative to cwd.

exclude?​

optional exclude?: (string | RegExp)[]

Defined in: static.ts:32

Route paths to skip for this app (e.g. auth-gated/personalized pages that shouldn't be baked into a public static export). Matched against the prefix-free route path. A string containing :name tokens ("/pets/:id") is a route template: it excludes the dynamic route itself and every concrete page enumerated for it (/pets/1, /pets/2, ...).

paths?​

optional paths?: string[]

Defined in: static.ts:27

Extra prefix-free route paths to crawl for this app, beyond what appDir discovers.

routePrefix?​

optional routePrefix?: string

Defined in: static.ts:25

URL prefix this app's React route is mounted at. In the multi-app apps form, also becomes this app's output subdirectory prefix, so routes from different apps can't collide in outDir and the exported site preserves each app's mount-relative structure (e.g. an admin app mounted at /admin writes to <outDir>/admin/...). Use "" — not "/" — for an app mounted at the site root; routePrefix is concatenated directly with each route (which already starts with /), so a "/" prefix produces a double slash. Default "".