static

generate

当 SSG 需要从其他模块（例如 Vite 插件）生成时，使用此函数。此函数应传入入口模块和 Qwik City 计划的路径。

export declare function generate(
  opts: StaticGenerateOptions,
): Promise<StaticGenerateResult>;

参数

类型

描述

opts

StaticGenerateOptions

Promise<StaticGenerateResult>

编辑此部分

StaticGenerateOptions

export interface StaticGenerateOptions extends StaticGenerateRenderOptions

扩展： StaticGenerateRenderOptions

属性

修饰符

类型

描述

basePathname?

string

(可选) 默认值为 /

qwikCityPlanModulePath

string

导出默认 @qwik-city-plan 的 Qwik City 计划模块的路径。

renderModulePath

string

导出默认渲染函数的 SSR 模块的路径。在大多数情况下，它将是 ./src/entry.ssr.tsx。

rootDir?

string

(可选)

编辑此部分

StaticGenerateRenderOptions

export interface StaticGenerateRenderOptions extends RenderOptions

扩展： RenderOptions

属性

修饰符

类型

描述

emit404Pages?

boolean

(可选) 如果静态构建不应写入自定义或默认的 404.html 页面，则设置为 false。默认值为 true。

emitData?

boolean

(可选) 如果生成的 q-data.json 数据文件不应写入磁盘，则设置为 false。默认值为 true。

emitHtml?

boolean

(可选) 如果生成的静态 HTML 文件不应写入磁盘，则设置为 false。设置为 false 对于 SSG 仅应将 q-data.json 文件写入磁盘很有用。默认值为 true。

exclude?

string[]

(可选) 定义相对于源 routes 目录的应该不进行静态生成的文件系统路由。接受通配符行为。这应该不包括“基本”路径名。exclude 始终优先于 include。

include?

string[]

(可选) 定义相对于源 routes 目录的应该进行静态生成的文件系统路由。接受通配符行为。这应该不包括“基本”路径名。如果未提供，则所有路由都将进行静态生成。exclude 始终优先于 include。

log?

'debug'

(可选) 日志级别。

maxTasksPerWorker?

number

(可选) 每个工作程序一次运行的最大任务数。默认值为 20。

maxWorkers?

number

(可选) 生成静态页面时要使用的最大工作程序数量。默认值为可用的 CPU 数量。

origin

string

URL origin，它是方案（协议）和主机名（域名）的组合。例如，https://qwik.node.org.cn 的协议为 https://，域名是 qwik.dev。但是，origin 不包括 pathname。

origin 用于在静态站点生成 (SSG) 期间提供完整的 URL，以及模拟完整的 URL 而不是仅模拟 pathname。例如，为了渲染正确的规范标签 URL 或 sitemap.xml 中的 URL，必须提供 origin。

如果站点也以 / 以外的路径名开头，请在 Qwik City 配置选项中使用 basePathname 选项。

outDir

string

应该写入静态文件的文件系统目录。

sitemapOutFile?

string | null

(可选) 写入 sitemap.xml 的文件系统路径。默认值为 sitemap.xml，并写入 outDir 的根目录。设置为 null 将阻止创建站点地图。

编辑此部分

StaticGenerateResult

export interface StaticGenerateResult

属性

修饰符

类型

描述

number

number

number

string[]