API › @qwik.dev/qwik-router/ssg

generate

Use this function when SSG should be generated from another module, such as a Vite plugin. This function's should be passed the paths of the entry module and Qwik Router Plan.

export declare function generate(opts: SsgGenerateOptions): Promise<SsgResult>;

Parameter	Type	Description
opts	SsgGenerateOptions

Returns:

Promise<SsgResult>

Edit this section

runSsg

Run SSG as a standalone process. Writes _static-paths.json to outDir and exits with code 0 on success, 1 on error.

Intended to be called from a generated run-ssg.js wrapper that provides render/config.

export declare function runSsg(opts: SsgGenerateOptions): Promise<never>;

Parameter	Type	Description
opts	SsgGenerateOptions

Returns:

Promise<never>

Edit this section

SsgInternalOptions

Internal SSG options that include the render function and router config.

export interface SsgGenerateOptions extends SsgOptions

Extends: SsgOptions

Property	Type	Description
qwikRouterConfig	QwikRouterConfig	The Qwik Router Config object (default export from `@qwik-router-config`).
render	Render	The SSR render function (default export from entry.ssr).
workerFilePath?	string \| URL	(Optional) Path or URL to the worker entry file. Workers are spawned using this file. When run-ssg.js serves as both main and worker entry, this should be `import.meta.url` of that file.

Edit this section

SsgOptions

export interface SsgOptions extends SsgRenderOptions

Extends: SsgRenderOptions

Property	Modifiers	Type	Description
basePathname?		string	(Optional) Defaults to `/`
rootDir?		string	(Optional)

Edit this section

SsgRenderOptions

export interface SsgRenderOptions extends RenderOptions

Extends: RenderOptions

Property	Type	Description
emit404Pages?	boolean	(Optional) Set to `false` if the static build should not write custom or default `404.html` pages. Defaults to `true`.
emitData?	boolean	(Optional) Set to `false` if the generated `q-data.json` data files should not be written to disk. Defaults to `true`.
emitHtml?	boolean	(Optional) Set to `false` if the generated static HTML files should not be written to disk. Setting to `false` is useful if the SSG should only write the `q-data.json` files to disk. Defaults to `true`.
exclude?	string[]	(Optional) Defines file system routes relative to the source `routes` directory that should not be static generated. Accepts wildcard behavior. This should not include the "base" pathname. `exclude` always takes priority over `include`.
include?	string[]	(Optional) Defines file system routes relative to the source `routes` directory that should be static generated. Accepts wildcard behavior. This should not include the "base" pathname. If not provided, all routes will be static generated. `exclude` always takes priority over `include`.
log?	'debug' \| 'quiet'	(Optional) Log level. `'quiet'` suppresses per-page output, `'debug'` enables verbose logging.
maxTasksPerWorker?	number	(Optional) Maximum number of tasks to be running at one time per worker. Defaults to `20`.
maxWorkers?	number	(Optional) Maximum number of workers to use while generating the static pages. Defaults to the number of CPUs available.
origin	string	The URL `origin`, which is a combination of the scheme (protocol) and hostname (domain). For example, `https://qwik.dev` has the protocol `https://` and domain `qwik.dev`. However, the `origin` does not include a `pathname`. The `origin` is used to provide a full URL during Static Site Generation (SSG), and to simulate a complete URL rather than just the `pathname`. For example, in order to render a correct canonical tag URL or URLs within the `sitemap.xml`, the `origin` must be provided too. If the site also starts with a pathname other than `/`, please use the `basePathname` option in the Qwik Router config options.
outDir	string	File system directory where the static files should be written.
sitemapOutFile?	string \| null	(Optional) File system path to write the `sitemap.xml` to. Defaults to `sitemap.xml` and written to the root of the `outDir`. Setting to `null` will prevent the sitemap from being created.

Edit this section

startWorker

Bootstrap a worker thread for SSG rendering. Called from the generated run-ssg.js when it detects it's running as a worker thread.

export declare function startWorker(
  opts: Pick<SsgGenerateOptions, "render" | "qwikRouterConfig">,
): Promise<void>;

Parameter	Type	Description
opts	Pick<SsgGenerateOptions, 'render' \| 'qwikRouterConfig'>	Must include `render` and `qwikRouterConfig` (imported by the worker entry). The remaining serializable options come from `workerData`.

Returns:

Promise<void>

Edit this section

StaticGenerateResult

export interface SsgResult

Property	Modifiers	Type	Description
duration		number
errors		number
rendered		number
staticPaths		string[]

Edit this section