static

generate

この関数は、Viteプラグインなど、別のモジュールからSSGを生成する必要がある場合に使用します。この関数には、エントリモジュールと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ディレクトリを基準とした、静的に生成されないファイルシステムルートを定義します。ワイルドカード動作を受け入れます。「base」パス名は含まれません。excludeは常にincludeよりも優先されます。

include?

string[]

(オプション) ソースroutesディレクトリを基準とした、静的に生成されるファイルシステムルートを定義します。ワイルドカード動作を受け入れます。「base」パス名は含まれません。指定しない場合、すべてのルートが静的に生成されます。excludeは常にincludeよりも優先されます。

log?

'debug'

(オプション) ログレベル。

maxTasksPerWorker?

number

(オプション) ワーカーごとに同時に実行できるタスクの最大数です。デフォルトは20です。

maxWorkers?

number

(オプション) 静的ページを生成する際に使用するワーカーの最大数です。デフォルトは使用可能なCPU数です。

origin

string

スキーム（プロトコル）とホスト名（ドメイン）を組み合わせたURLのoriginです。たとえば、https://qwik.dokyumento.jpのプロトコルはhttps://、ドメインはqwik.devです。ただし、originにはpathnameは含まれません。