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?

数字

(可选)

strategy

'auto'

编辑此部分

InOrderDisabled

export interface InOrderDisabled

属性

修饰符

类型

描述

strategy

'disabled'

编辑此部分

InOrderStreaming

export type InOrderStreaming = InOrderAuto | InOrderDisabled | InOrderDirect;

参考： InOrderAuto, InOrderDisabled

编辑此部分

PrefetchImplementation

export interface PrefetchImplementation

属性

修饰符

类型

描述

linkInsert?

'js-append' | 'html-append' | null

(可选) js-append: 使用 JS 运行时创建每个 <link> 并追加到 body。

html-append: 在 html 中渲染每个 <link>，追加到 body 的末尾。

linkRel?

'prefetch' | 'preload' | 'modulepreload' | null

(可选) 当使用链接时，<link rel="..."> 属性的值。如果插入链接，则默认为 prefetch。

prefetchEvent?

'always' | null

(可选) 使用包含应预取的捆绑包的详细信息数据调度 qprefetch 事件。事件调度脚本将内联到文档的 HTML 中，因此此事件的任何侦听器都应该已经准备好处理该事件。

此实现将注入类似于

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

默认情况下，prefetchEvent 实现将设置为 always。

workerFetchInsert?

'always' | 'no-link-support' | null

(可选) always: 始终包含 worker fetch JS 运行时。

no-link-support: 仅当浏览器不支持 <link> 预取/预加载/模块预加载时，才包含 worker fetch JS 运行时。

编辑此部分

PrefetchResource

export interface PrefetchResource

属性

修饰符

类型

描述

字符串

PrefetchStrategy

export interface PrefetchStrategy

属性

修饰符

类型

描述

implementation?

PrefetchImplementation

(可选)

symbolsToPrefetch?

SymbolsToPrefetch

(可选)

编辑此部分

QwikLoaderOptions

export interface QwikLoaderOptions

属性

修饰符

类型

描述

include?

'always' | 'never' | 'auto'

(可选)

position?

'top' | 'bottom'

(可选)

编辑此部分

渲染

export type Render = RenderToString | RenderToStream;

参考： RenderToString, RenderToStream

编辑此部分

RenderOptions

export interface RenderOptions extends SerializeDocumentOptions

扩展： SerializeDocumentOptions

属性

修饰符

类型

描述

base?

字符串 | ((options: RenderOptions) => 字符串)

(可选) 指定客户端构建的 JS 文件的根目录。设置一个 base，将导致在 q:container 元素中渲染 q:base 属性。

containerAttributes?

Record<字符串, 字符串>

(可选)

containerTagName?

字符串

(可选) 当设置时，应用程序将被序列化为片段。返回的 html 不是完整的文档。默认为 html

locale?

字符串 | ((options: RenderOptions) => 字符串)

(可选) 渲染文档时使用的语言。

prefetchStrategy?

PrefetchStrategy | null

(可选)

qwikLoader?

QwikLoaderOptions

(可选) 指定是否将 Qwik Loader 脚本添加到文档中。

默认为 { include: true }。

qwikPrefetchServiceWorker?

QwikPrefetchServiceWorkerOptions

(可选) 指定是否将 Qwik Prefetch Service Worker 脚本添加到文档中。

默认为 { include: false }。注意：这在将来可能会改变。

serverData?

Record<字符串, 任何>

(可选)

snapshot?

布尔值

(可选) 默认为 true

编辑此部分

RenderResult

export interface RenderResult

属性

修饰符

类型

描述

isStatic

布尔值

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: 数字; render: 数字; snapshot: 数字; }

编辑此部分

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: 数字; snapshot: 数字; }

编辑此部分

resolveManifest

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

参数

类型

描述

manifest

QwikManifest | ResolvedManifest | undefined

ResolvedManifest | undefined

编辑此部分

SerializeDocumentOptions

export interface SerializeDocumentOptions

属性

修饰符

类型

描述

debug?

布尔值

(可选)

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;
}

编辑此部分