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?

数値

(オプション)

戦略

'auto'

このセクションを編集

InOrderDisabled

export interface InOrderDisabled

プロパティ

修飾子

型

説明

戦略

'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: 常にワーカーフェッチ JS ランタイムを含めます。

no-link-support: ブラウザーが <link> prefetch/preload/modulepreload をサポートしていない場合にのみ、ワーカーフェッチ JS ランタイムを含めます。

このセクションを編集

PrefetchResource

export interface PrefetchResource

プロパティ

修飾子

型

説明

文字列

PrefetchStrategy

export interface PrefetchStrategy

プロパティ

修飾子

型

説明

implementation?

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 ファイルのルートを指定します。ベースを設定すると、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

Auto: ドキュメントで使用されるすべての可能な QRL をプリフェッチします。デフォルト

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

参考文献: PrefetchResource

このセクションを編集

バージョン

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

このセクションを編集