server

getQwikLoaderScript

Provides the qwikloader.js file as a string. Useful for tooling to inline the qwikloader script into HTML.

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

Parameter	Type	Description
opts	{ debug?: boolean; }	(Optional)

Returns:

string

Edit this section

getQwikPrefetchWorkerScript

Provides the qwik-prefetch-service-worker.js file as a string. Useful for tooling to inline the qwik-prefetch-service-worker script into HTML.

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

Parameter	Type	Description
opts	{ debug?: boolean; }	(Optional)

Returns:

string

Edit this section

InOrderAuto

export interface InOrderAuto

Property	Type	Description
maximunChunk?	number	(Optional)
maximunInitialChunk?	number	(Optional)
strategy	'auto'

Edit this section

InOrderDisabled

export interface InOrderDisabled

Property	Modifiers	Type	Description
strategy		'disabled'

Edit this section

InOrderStreaming

export type InOrderStreaming = InOrderAuto | InOrderDisabled | InOrderDirect;

References: InOrderAuto, InOrderDisabled

Edit this section

PrefetchImplementation

Warning: This API is now obsolete.

Use preloader instead

export interface PrefetchImplementation

Property	Type	Description
linkFetchPriority?	'auto' \| 'low' \| 'high' \| null	(Optional)
linkInsert?	'js-append' \| 'html-append' \| null	(Optional)
linkRel?	'prefetch' \| 'preload' \| 'modulepreload' \| null	(Optional)
prefetchEvent?	'always' \| null	(Optional)
workerFetchInsert?	'always' \| 'no-link-support' \| null	(Optional)

Edit this section

PrefetchResource

export interface PrefetchResource

Property	Modifiers	Type	Description
imports		PrefetchResource[]
url		string

Edit this section

PrefetchStrategy

export interface PrefetchStrategy

Property	Modifiers	Type	Description
implementation?		PrefetchImplementation	(Optional)
symbolsToPrefetch?		SymbolsToPrefetch	(Optional)

Edit this section

PreloaderOptions

export interface PreloaderOptions

Property	Type	Description
debug?	boolean	(Optional) Log preloader debug information to the console. Defaults to `false`
maxBufferedPreloads?	number	(Optional) Maximum number of simultaneous preload links that the preloader will maintain. If you set this higher, the browser will have all JS files in memory sooner, but it will contend with other resource downloads. Furthermore, if a bundle suddenly becomes more likely, it will have to wait longer to be preloaded. Bundles that reach 100% probability (static imports of other bundles) will always be preloaded immediately, no limit. Defaults to `25`
preloadProbability?	number	(Optional) The minimum probability for a bundle to be added to the preload queue. Defaults to `0.35` (35% probability)
ssrPreloadProbability?	number	(Optional) The minimum probability for a bundle to be added as a preload link during SSR. Defaults to `0.7` (70% probability)
ssrPreloads?	number	(Optional) Maximum number of preload links to add during SSR. These instruct the browser to preload likely bundles before the preloader script is active. This most likely includes the core and the preloader script itself. Setting this to 0 will disable all preload links. Preload links can delay LCP, which is a Core Web Vital, but it can increase TTI, which is not a Core Web Vital but more noticeable to the user. Defaults to `5`

Edit this section

QwikLoaderOptions

export interface QwikLoaderOptions

Property	Modifiers	Type	Description
include?		'always' \| 'never' \| 'auto'	(Optional)
position?		'top' \| 'bottom'	(Optional)

Edit this section

Render

export type Render = RenderToString | RenderToStream;

References: RenderToString, RenderToStream

Edit this section

RenderOptions

export interface RenderOptions extends SerializeDocumentOptions

Extends: SerializeDocumentOptions

Property	Type	Description
base?	string \| ((options: RenderOptions) => string)	(Optional) Specifies the root of the JS files of the client build. Setting a base, will cause the render of the `q:base` attribute in the `q:container` element.
containerAttributes?	Record<string, string>	(Optional)
containerTagName?	string	(Optional) When set, the app is serialized into a fragment. And the returned html is not a complete document. Defaults to `html`
locale?	string \| ((options: RenderOptions) => string)	(Optional) Language to use when rendering the document.
prefetchStrategy?	PrefetchStrategy \| null	(Optional)
preloader?	PreloaderOptions \| boolean	(Optional)
qwikLoader?	QwikLoaderOptions	(Optional) Specifies if the Qwik Loader script is added to the document or not. Defaults to `{ include: true }`.
qwikPrefetchServiceWorker?	QwikPrefetchServiceWorkerOptions	(Optional)
serverData?	Record<string, any>	(Optional)
snapshot?	boolean	(Optional) Defaults to `true`

Edit this section

RenderResult

export interface RenderResult

Property	Type	Description
isStatic	boolean
manifest?	QwikManifest	(Optional)
prefetchResources	PrefetchResource[]
snapshotResult	SnapshotResult \| undefined

Edit this section

renderToStream

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

References: RenderToStreamOptions, RenderToStreamResult

Edit this section

RenderToStream

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

References: RenderToStreamOptions, RenderToStreamResult

Edit this section

RenderToStreamOptions

export interface RenderToStreamOptions extends RenderOptions

Extends: RenderOptions

Property	Modifiers	Type	Description
stream		StreamWriter
streaming?		StreamingOptions	(Optional)

Edit this section

RenderToStreamResult

export interface RenderToStreamResult extends RenderResult

Extends: RenderResult

Property	Modifiers	Type	Description
flushes		number
size		number
timing		{ firstFlush: number; render: number; snapshot: number; }

Edit this section

renderToString

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

References: RenderToStringOptions, RenderToStringResult

Edit this section

RenderToString

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

References: RenderToStringOptions, RenderToStringResult

Edit this section

RenderToStringOptions

export interface RenderToStringOptions extends RenderOptions

Extends: RenderOptions

Edit this section

RenderToStringResult

export interface RenderToStringResult extends RenderResult

Extends: RenderResult

Property	Modifiers	Type	Description
html		string
timing		{ render: number; snapshot: number; }

Edit this section

resolveManifest

Merges a given manifest with the built manifest and provides mappings for symbols.

export declare function resolveManifest(
  manifest?: Partial<QwikManifest | ResolvedManifest> | undefined,
): ResolvedManifest | undefined;

Parameter	Type	Description
manifest	Partial<QwikManifest \| ResolvedManifest> \| undefined	(Optional)

Returns:

ResolvedManifest | undefined

Edit this section

SerializeDocumentOptions

export interface SerializeDocumentOptions

Property	Type	Description
debug?	boolean	(Optional)
manifest?	Partial<QwikManifest \| ResolvedManifest>	(Optional)
symbolMapper?	SymbolMapperFn	(Optional)

Edit this section

setServerPlatform

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

Parameter	Type	Description
manifest	Partial<QwikManifest \| ResolvedManifest>	(Optional)

Returns:

Promise<void>

Edit this section

StreamingOptions

export interface StreamingOptions

Property	Modifiers	Type	Description
inOrder?		InOrderStreaming	(Optional)

Edit this section

SymbolsToPrefetch

Auto: Prefetch all possible QRLs used by the document. Default

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

References: PrefetchResource

Edit this section

versions

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

Edit this section