server

getQwikLoaderScript

以字串形式提供 qwikloader.js 檔案。適用於將 qwikloader 腳本內嵌到 HTML 的工具。

export declare function getQwikLoaderScript(opts?: { debug?: boolean }): string;

參數

類型

說明

opts

{ debug?: boolean; }

（可選）

字串

編輯此區段

getQwikPrefetchWorkerScript

以字串形式提供 qwik-prefetch-service-worker.js 檔案。適用於將 qwik-prefetch-service-worker 腳本內嵌到 HTML 的工具。

export declare function getQwikPrefetchWorkerScript(opts?: {
  debug?: boolean;
}): string;

參數

類型

說明

opts

{ debug?: boolean; }

（可選）

字串

編輯此區段

InOrderAuto

export interface InOrderAuto

屬性

修飾字

類型

說明

maximunChunk?

數字

（可選）

maximunInitialChunk?

數字

（可選）

策略

「自動」

編輯此區段

InOrderDisabled

export interface InOrderDisabled

屬性

修飾字

類型

說明

策略

「已停用」

編輯此區段

InOrderStreaming

export type InOrderStreaming = InOrderAuto | InOrderDisabled | InOrderDirect;

參考： InOrderAuto、InOrderDisabled

編輯此區段

PrefetchImplementation

export interface PrefetchImplementation

屬性

修飾字

類型

說明

linkInsert?

「js-append」|「html-append」| null

（可選） js-append：使用 JS 執行階段建立每個 <link> 並附加到主體。

html-append：在 html 中渲染每個 <link>，附加在主體的末尾。

linkRel?

「prefetch」|「preload」|「modulepreload」| null

（可選） 使用連結時 <link rel="..."> 屬性的值。如果插入連結，則預設為 prefetch。

prefetchEvent?

「總是」| null

（可選） 發送一個 qprefetch 事件，其中包含應預先擷取的組合的詳細資料。事件發送腳本將會內嵌到文件的 HTML 中，因此此事件的任何監聽器都應該已準備好處理事件。

此實作將會插入類似於以下內容的腳本

<script type="module">
  document.dispatchEvent(new CustomEvent("qprefetch", { detail:{ "bundles": [...] } }))
</script>

預設情況下，prefetchEvent 實作將會設定為 always。

workerFetchInsert?

「總是」|「no-link-support」| null

（可選） 總是：始終包含 worker fetch JS 執行階段。

no-link-support：僅在瀏覽器不支援 <link> prefetch/preload/modulepreload 時才包含 worker fetch JS 執行階段。

編輯此區段

PrefetchResource

export interface PrefetchResource

屬性

修飾字

類型

說明

字串

PrefetchStrategy

export interface PrefetchStrategy

屬性

修飾字

類型

說明

實作？

PrefetchImplementation

（可選）

symbolsToPrefetch?

SymbolsToPrefetch

（可選）

編輯此區段

QwikLoaderOptions

export interface QwikLoaderOptions

屬性

修飾字

類型

說明

include？

'always' | 'never' | 'auto'

（可選）

position？

'top' | 'bottom'

（可選）

編輯此區段

Render

export type Render = RenderToString | RenderToStream;

參考： RenderToString, RenderToStream

編輯此區段

RenderOptions

export interface RenderOptions extends SerializeDocumentOptions

擴展： SerializeDocumentOptions

屬性

修飾字

類型

說明

base？

string | ((options: RenderOptions) => string)

（選填） 指定客戶端構建的 JS 文件的根目錄。設置 base 將導致在 q:container 元素中呈現 q:base 屬性。

containerAttributes？

Record<string, string>

（可選）

containerTagName？

字串

（選填） 設定後，應用程式會被序列化為片段。並且返回的 html 不是完整的文檔。默認為 html

locale？

string | ((options: RenderOptions) => string)

（選填） 呈現文檔時使用的語言。

prefetchStrategy？

PrefetchStrategy | null

（可選）

qwikLoader？

QwikLoaderOptions

（選填） 指定是否將 Qwik Loader 腳本添加到文檔中。

默認為 { include: true }。

qwikPrefetchServiceWorker？

QwikPrefetchServiceWorkerOptions

（選填） 指定是否將 Qwik Prefetch Service Worker 腳本添加到文檔中。

默認為 { include: false }。注意：這在未來可能會有所改變。

serverData？

Record<string, any>

（可選）

snapshot？

boolean

（選填） 默認為 true

編輯此區段

RenderResult

export interface RenderResult

屬性

修飾字

類型

說明

isStatic

boolean

manifest？

QwikManifest

（可選）

prefetchResources

PrefetchResource[]

snapshotResult

SnapshotResult | undefined

編輯此區段

renderToStream

export type RenderToStream = (
  opts: RenderToStreamOptions,
) => Promise<RenderToStreamResult>;

參考： RenderToStreamOptions, RenderToStreamResult

編輯此區段

RenderToStream

export type RenderToStream = (
  opts: RenderToStreamOptions,
) => Promise<RenderToStreamResult>;

參考： RenderToStreamOptions, RenderToStreamResult

編輯此區段

RenderToStreamOptions

export interface RenderToStreamOptions extends RenderOptions

擴展： RenderOptions

屬性

修飾字

類型

說明

StreamWriter

（可選）

RenderToStreamResult

export interface RenderToStreamResult extends RenderResult

擴展： RenderResult

屬性

修飾字

類型

說明

flushes

數字

size

數字

timing

{ firstFlush: number; render: number; snapshot: number; }

編輯此區段

renderToString

export type RenderToString = (
  opts: RenderToStringOptions,
) => Promise<RenderToStringResult>;

參考： RenderToStringOptions, RenderToStringResult

編輯此區段

RenderToString

export type RenderToString = (
  opts: RenderToStringOptions,
) => Promise<RenderToStringResult>;

參考： RenderToStringOptions, RenderToStringResult

編輯此區段

RenderToStringOptions

export interface RenderToStringOptions extends RenderOptions

擴展： RenderOptions

編輯此區段

RenderToStringResult

export interface RenderToStringResult extends RenderResult

擴展： RenderResult

屬性

修飾字

類型

說明

html

字串

timing

{ render: number; snapshot: number; }

編輯此區段

resolveManifest

export declare function resolveManifest(
  manifest: QwikManifest | ResolvedManifest | undefined,
): ResolvedManifest | undefined;

參數

類型

說明

manifest

QwikManifest | ResolvedManifest | undefined

ResolvedManifest | undefined

編輯此區段

SerializeDocumentOptions

export interface SerializeDocumentOptions

屬性

修飾字

類型

說明

debug？

boolean

（可選）

manifest？

QwikManifest | ResolvedManifest

（可選）

symbolMapper？

SymbolMapperFn

（可選）

編輯此區段

setServerPlatform

export declare function setServerPlatform(
  manifest: QwikManifest | ResolvedManifest | undefined,
): Promise<void>;

參數

類型

說明

manifest

QwikManifest | ResolvedManifest | undefined

Promise<void>

編輯此區段

StreamingOptions

export interface StreamingOptions

屬性

修飾字

類型

說明

inOrder？

InOrderStreaming

（可選）

編輯此區段

SymbolsToPrefetch

自動：預取文檔使用的所有可能的 QRL。默認

export type SymbolsToPrefetch =
  | "auto"
  | ((opts: { manifest: QwikManifest }) => PrefetchResource[]);

參考： PrefetchResource

編輯此區段

版本

versions: {
    readonly qwik: string;
    readonly qwikDom: string;
}

編輯此區段