Merge pull request #7610 from QwikDev/tweak-preloader

shairez · web-flow · commit b0b61a71ad7c · 2025-05-19T18:05:33.000+03:00
diff --git a/packages/docs/src/repl/worker/repl-request-handler.ts b/packages/docs/src/repl/worker/repl-request-handler.ts
@@ -133,7 +133,7 @@ const injectDevHtml = (clientId: string, html?: string) => {
   });
 
   document.addEventListener('qsymbol', (ev) => {
-    const symbolName = ev.detail;
+    const symbolName = ev.detail?.symbol;
     sendToServerWindow({
       kind: 'symbol',
       scope: 'client',
diff --git a/packages/docs/src/root.tsx b/packages/docs/src/root.tsx
@@ -76,5 +76,7 @@ export default component$(() => {
 
 export function collectSymbols() {
   (window as any).symbols = [];
-  document.addEventListener('qsymbol', (e) => (window as any).symbols.push((e as any).detail));
+  document.addEventListener('qsymbol', (e) =>
+    (window as any).symbols.push((e as any).detail.symbol)
+  );
 }
diff --git a/packages/docs/src/routes/api/qwik-server/api.json b/packages/docs/src/routes/api/qwik-server/api.json
@@ -166,7 +166,7 @@
         }
       ],
       "kind": "Interface",
-      "content": "```typescript\nexport interface RenderOptions extends SerializeDocumentOptions \n```\n**Extends:** [SerializeDocumentOptions](#serializedocumentoptions)\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[base?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| ((options: [RenderOptions](#renderoptions)<!-- -->) =&gt; string)\n\n\n</td><td>\n\n_(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.\n\n\n</td></tr>\n<tr><td>\n\n[containerAttributes?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, string&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[containerTagName?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_ When set, the app is serialized into a fragment. And the returned html is not a complete document. Defaults to `html`\n\n\n</td></tr>\n<tr><td>\n\n[locale?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| ((options: [RenderOptions](#renderoptions)<!-- -->) =&gt; string)\n\n\n</td><td>\n\n_(Optional)_ Language to use when rendering the document.\n\n\n</td></tr>\n<tr><td>\n\n[prefetchStrategy?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[PrefetchStrategy](#prefetchstrategy) \\| null\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[preloader?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[PreloaderOptions](#preloaderoptions) \\| boolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[qwikLoader?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[QwikLoaderOptions](#qwikloaderoptions)\n\n\n</td><td>\n\n_(Optional)_ Specifies if the Qwik Loader script is added to the document or not.\n\nDefaults to `{ include: true }`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[qwikPrefetchServiceWorker?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nQwikPrefetchServiceWorkerOptions\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[serverData?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, any&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[snapshot?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Defaults to `true`\n\n\n</td></tr>\n</tbody></table>",
+      "content": "```typescript\nexport interface RenderOptions extends SerializeDocumentOptions \n```\n**Extends:** [SerializeDocumentOptions](#serializedocumentoptions)\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[base?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| ((options: [RenderOptions](#renderoptions)<!-- -->) =&gt; string)\n\n\n</td><td>\n\n_(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.\n\n\n</td></tr>\n<tr><td>\n\n[containerAttributes?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, string&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[containerTagName?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_ When set, the app is serialized into a fragment. And the returned html is not a complete document. Defaults to `html`\n\n\n</td></tr>\n<tr><td>\n\n[locale?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| ((options: [RenderOptions](#renderoptions)<!-- -->) =&gt; string)\n\n\n</td><td>\n\n_(Optional)_ Language to use when rendering the document.\n\n\n</td></tr>\n<tr><td>\n\n[prefetchStrategy?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[PrefetchStrategy](#prefetchstrategy) \\| null\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[preloader?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[PreloaderOptions](#preloaderoptions) \\| false\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[qwikLoader?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[QwikLoaderOptions](#qwikloaderoptions)\n\n\n</td><td>\n\n_(Optional)_ Specifies if the Qwik Loader script is added to the document or not.\n\nDefaults to `{ include: true }`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[qwikPrefetchServiceWorker?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nQwikPrefetchServiceWorkerOptions\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[serverData?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, any&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[snapshot?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Defaults to `true`\n\n\n</td></tr>\n</tbody></table>",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
       "mdFile": "qwik.renderoptions.md"
     },
diff --git a/packages/docs/src/routes/api/qwik-server/index.mdx b/packages/docs/src/routes/api/qwik-server/index.mdx
@@ -715,7 +715,7 @@ _(Optional)_
 
 </td><td>
 
-[PreloaderOptions](#preloaderoptions) \| boolean
+[PreloaderOptions](#preloaderoptions) \| false
 
 </td><td>
 
diff --git a/packages/docs/src/routes/api/qwik/api.json b/packages/docs/src/routes/api/qwik/api.json
@@ -2194,7 +2194,7 @@
         }
       ],
       "kind": "TypeAlias",
-      "content": "Emitted by qwik-loader when a module was lazily loaded\n\n\n```typescript\nexport type QwikSymbolEvent = CustomEvent<{\n    symbol: string;\n    element: Element;\n    reqTime: number;\n}>;\n```",
+      "content": "Emitted by qwik-loader when a module was lazily loaded\n\n\n```typescript\nexport type QwikSymbolEvent = CustomEvent<{\n    symbol: string;\n    element: Element;\n    reqTime: number;\n    qBase?: string;\n    qManifest?: string;\n    qVersion?: string;\n    href?: string;\n}>;\n```",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/render/jsx/types/jsx-qwik-events.ts",
       "mdFile": "qwik.qwiksymbolevent.md"
     },
diff --git a/packages/docs/src/routes/api/qwik/index.mdx b/packages/docs/src/routes/api/qwik/index.mdx
@@ -4383,6 +4383,10 @@ export type QwikSymbolEvent = CustomEvent<{
   symbol: string;
   element: Element;
   reqTime: number;
+  qBase?: string;
+  qManifest?: string;
+  qVersion?: string;
+  href?: string;
 }>;
 ```
 
diff --git a/packages/docs/src/routes/docs/(qwikcity)/guides/bundle/index.mdx b/packages/docs/src/routes/docs/(qwikcity)/guides/bundle/index.mdx
@@ -139,7 +139,7 @@ To collect symbol usage from a running application:
     ```html
     <script>
       window.symbols = [];
-      document.addEventListener('qsymbol', (e) => window.symbols.push(e.detail));
+      document.addEventListener('qsymbol', (e) => window.symbols.push(e.detail.symbol));
     </script>
     ```
 2. Perform some set of operations mimicking user behavior.
diff --git a/packages/qwik/src/core/preloader/bundle-graph.ts b/packages/qwik/src/core/preloader/bundle-graph.ts
@@ -1,5 +1,5 @@
 import { isBrowser } from '@builder.io/qwik/build';
-import { config, doc } from './constants';
+import { config, isJSRegex } from './constants';
 import { adjustProbabilities, bundles, log, shouldResetFactor, trigger } from './queue';
 import type { BundleGraph, BundleImport, ImportProbability } from './types';
 import { BundleImportState_None, BundleImportState_Alias } from './types';
@@ -8,15 +8,9 @@ export let base: string | undefined;
 export let graph: BundleGraph;
 
 const makeBundle = (name: string, deps?: ImportProbability[]) => {
-  const url = name.endsWith('.js')
-    ? doc
-      ? new URL(`${base}${name}`, doc.baseURI).toString()
-      : name
-    : null;
   return {
     $name$: name,
-    $url$: url,
-    $state$: url ? BundleImportState_None : BundleImportState_Alias,
+    $state$: isJSRegex.test(name) ? BundleImportState_None : BundleImportState_Alias,
     $deps$: shouldResetFactor ? deps?.map((d) => ({ ...d, $factor$: 1 })) : deps,
     $inverseProbability$: 1,
     $createdTs$: Date.now(),
@@ -37,7 +31,11 @@ export const parseBundleGraph = (serialized: (string | number)[]) => {
       if (idx < 0) {
         probability = -idx / 10;
       } else {
-        deps.push({ $name$: serialized[idx] as string, $probability$: probability, $factor$: 1 });
+        deps.push({
+          $name$: serialized[idx] as string,
+          $importProbability$: probability,
+          $factor$: 1,
+        });
       }
       i++;
     }
diff --git a/packages/qwik/src/core/preloader/constants.ts b/packages/qwik/src/core/preloader/constants.ts
@@ -19,3 +19,5 @@ export const rel =
 
 // Global state
 export const loadStart = Date.now();
+
+export const isJSRegex = /\.[mc]?js$/;
diff --git a/packages/qwik/src/core/preloader/preloader.unit.ts b/packages/qwik/src/core/preloader/preloader.unit.ts
@@ -21,6 +21,5 @@ test('preloader script', () => {
    * dereference objects etc, but that actually results in worse compression
    */
   const compressed = compress(Buffer.from(preLoader), { mode: 1, quality: 11 });
-  expect(compressed.length).toBe(1722);
-  expect(preLoader.length).toBe(5107);
+  expect([compressed.length, preLoader.length]).toEqual([1878, 5614]);
 });
diff --git a/packages/qwik/src/core/preloader/queue.ts b/packages/qwik/src/core/preloader/queue.ts
@@ -8,6 +8,7 @@ import {
   BundleImportState_Preload,
   BundleImportState_Queued,
 } from './types';
+import type { QwikSymbolEvent } from '../render/jsx/types/jsx-qwik-events';
 
 export const bundles: BundleImports = new Map();
 export let shouldResetFactor: boolean;
@@ -81,8 +82,8 @@ export const trigger = () => {
         Math.max(1, config.$maxIdlePreloads$ * probability)
       : // While the graph is not available, we limit to 2 preloads
         2;
-    // When we're 100% sure, everything needs to be queued
-    if (probability === 1 || preloadCount < allowedPreloads) {
+    // When we're 99% sure, everything needs to be queued
+    if (probability >= 0.99 || preloadCount < allowedPreloads) {
       queue.shift();
       preloadOne(bundle);
     } else {
@@ -120,7 +121,8 @@ const preloadOne = (bundle: BundleImport) => {
     );
 
   const link = doc.createElement('link');
-  link.href = bundle.$url$!;
+  // Only bundles with state none are js bundles
+  link.href = new URL(`${base}${bundle.$name$}`, doc.baseURI).toString();
   link.rel = rel;
   // Needed when rel is 'preload'
   link.as = 'script';
@@ -140,22 +142,34 @@ const preloadOne = (bundle: BundleImport) => {
   doc.head.appendChild(link);
 };
 
+/**
+ * Adjust the probability of a bundle based on the probability of its dependent bundles, and queue
+ * it if it's likely enough to be preloaded.
+ *
+ * Note that if the probability is 100%, we treat the dynamic imports as 99% sure, and both will be
+ * preloaded without limit.
+ *
+ * We also limit "organic" probability to 98% so they don't get unlimited preloads.
+ */
 export const adjustProbabilities = (
   bundle: BundleImport,
-  adjustFactor: number,
+  newInverseProbability: number,
   seen?: Set<BundleImport>
 ) => {
   if (seen?.has(bundle)) {
     return;
   }
 
   const previousInverseProbability = bundle.$inverseProbability$;
-  bundle.$inverseProbability$ *= adjustFactor;
+  bundle.$inverseProbability$ = newInverseProbability;
+  // Don't propagate tiny changes
   if (previousInverseProbability - bundle.$inverseProbability$ < 0.01) {
     return;
   }
 
   if (
+    // don't queue until we have initialized the preloader
+    base != null &&
     bundle.$state$ < BundleImportState_Preload &&
     bundle.$inverseProbability$ < config.$invPreloadProbability$
   ) {
@@ -176,40 +190,57 @@ export const adjustProbabilities = (
     const probability = 1 - bundle.$inverseProbability$;
     for (const dep of bundle.$deps$) {
       const depBundle = getBundle(dep.$name$)!;
-      const prevAdjust = dep.$factor$;
+      if (depBundle.$inverseProbability$ === 0) {
+        // it's already at max probability
+        continue;
+      }
       /**
        * The chance that a dep won't be loaded is 1-(the chance that the dep will be loaded)*(the
        * chance that the current bundle will be loaded).
        *
        * We can multiply this chance together with all other bundle adjustments to get the chance
        * that a dep will be loaded given all the chances of the other bundles.
        *
-       * But when we're very likely to load the current bundle, make the dynamic imports more likely
+       * But when we're very likely to load the current bundle, make the dynamic imports very likely
        * too.
        */
-      const newInverseProbability =
-        dep.$probability$ !== 1 && adjustFactor < 0.1 ? 0.05 : 1 - dep.$probability$ * probability;
-
-      /** We need to undo the previous adjustment */
-      const factor = newInverseProbability / prevAdjust;
-      dep.$factor$ = factor;
+      let newInverseProbability: number;
+      if (
+        dep.$importProbability$ > 0.5 &&
+        (probability === 1 || (probability >= 0.99 && depsCount < 100))
+      ) {
+        depsCount++;
+        // we're loaded at max probability, so elevate dynamic imports to 99% sure
+        newInverseProbability = Math.min(0.01, 1 - dep.$importProbability$);
+      } else {
+        const newInverseImportProbability = 1 - dep.$importProbability$ * probability;
+        /** We need to undo the previous adjustment */
+        const prevAdjust = dep.$factor$;
+        const factor = newInverseImportProbability / prevAdjust;
+        // limit organic probability to 98%
+        newInverseProbability = Math.max(0.02, depBundle.$inverseProbability$ * factor);
+        dep.$factor$ = factor;
+      }
 
-      adjustProbabilities(depBundle, factor, seen);
+      adjustProbabilities(depBundle, newInverseProbability, seen);
     }
   }
 };
 
 export const handleBundle = (name: string, inverseProbability: number) => {
   const bundle = getBundle(name);
   if (bundle && bundle.$inverseProbability$ > inverseProbability) {
-    adjustProbabilities(bundle, inverseProbability / bundle.$inverseProbability$);
+    adjustProbabilities(bundle, inverseProbability);
   }
 };
 
+let depsCount: number;
+
 export const preload = (name: string | (number | string)[], probability?: number) => {
-  if (base == null || !name.length) {
+  if (!name?.length) {
     return;
   }
+  depsCount = 0;
 
   let inverseProbability = probability ? 1 - probability : 0.4;
   if (Array.isArray(name)) {
@@ -229,3 +260,15 @@ export const preload = (name: string | (number | string)[], probability?: number
     trigger();
   }
 };
+
+if (isBrowser) {
+  // Get early hints from qwikloader
+  document.addEventListener('qsymbol', (ev) => {
+    const { symbol, href } = (ev as QwikSymbolEvent).detail;
+    // the qrl class doesn't emit href, we don't need to preload
+    if (href) {
+      const hash = symbol.slice(symbol.lastIndexOf('_') + 1);
+      preload(hash, 1);
+    }
+  });
+}
diff --git a/packages/qwik/src/core/preloader/types.ts b/packages/qwik/src/core/preloader/types.ts
@@ -12,7 +12,6 @@ export type BundleInfo = {
 
 export type BundleImport = BundleInfo & {
   $name$: string;
-  $url$: string | null;
   $state$: number;
   $createdTs$: number;
   $waitedMs$: number;
@@ -25,7 +24,7 @@ export type ImportProbability = {
   /** Bundle name */
   $name$: string;
   /** Probability */
-  $probability$: number;
+  $importProbability$: number;
   /** Probability adjust factor */
   $factor$: number;
 };
diff --git a/packages/qwik/src/core/qwik.core.api.md b/packages/qwik/src/core/qwik.core.api.md
@@ -781,6 +781,10 @@ export type QwikSymbolEvent = CustomEvent<{
     symbol: string;
     element: Element;
     reqTime: number;
+    qBase?: string;
+    qManifest?: string;
+    qVersion?: string;
+    href?: string;
 }>;
 
 // @public @deprecated (undocumented)
diff --git a/packages/qwik/src/core/render/jsx/types/jsx-qwik-events.ts b/packages/qwik/src/core/render/jsx/types/jsx-qwik-events.ts
@@ -3,13 +3,28 @@ import type { AllEventKeys } from './jsx-qwik-attributes';
 /** Emitted by qwik-loader when an element becomes visible. Used by `useVisibleTask$` @public */
 export type QwikVisibleEvent = CustomEvent<IntersectionObserverEntry>;
 /** Emitted by qwik-loader when a module was lazily loaded @public */
-export type QwikSymbolEvent = CustomEvent<{ symbol: string; element: Element; reqTime: number }>;
+export type QwikSymbolEvent = CustomEvent<{
+  symbol: string;
+  element: Element;
+  reqTime: number;
+  qBase?: string;
+  qManifest?: string;
+  qVersion?: string;
+  href?: string;
+}>;
 /** Emitted by qwik-loader on document when the document first becomes interactive @public */
 export type QwikInitEvent = CustomEvent<{}>;
 /** Emitted by qwik-loader on document when the document first becomes idle @public */
 export type QwikIdleEvent = CustomEvent<{}>;
 /** Emitted by qwik-core on document when the a view transition start @public */
 export type QwikViewTransitionEvent = CustomEvent<ViewTransition>;
+/** Emitted by qwik-loader on document when there was an error loading a module @public */
+export type QwikErrorEvent = CustomEvent<
+  {
+    importError?: 'sync' | 'async' | 'no-symbol';
+    error: unknown;
+  } & QwikSymbolEvent['detail']
+>;
 
 // Utility types for supporting autocompletion in union types
 
diff --git a/packages/qwik/src/qwikloader.ts b/packages/qwik/src/qwikloader.ts
@@ -1,4 +1,8 @@
-import type { QwikSymbolEvent, QwikVisibleEvent } from './core/render/jsx/types/jsx-qwik-events';
+import type {
+  QwikErrorEvent,
+  QwikSymbolEvent,
+  QwikVisibleEvent,
+} from './core/render/jsx/types/jsx-qwik-events';
 import type { QContainerElement } from './core/container/container';
 import type { QContext } from './core/state/context';
 
@@ -117,7 +121,15 @@ type qWindow = Window & {
         let importError: undefined | 'sync' | 'async' | 'no-symbol';
         let error: undefined | Error;
         const isSync = qrl.startsWith('#');
-        const eventData = { qBase, qManifest, qVersion, href, symbol, element, reqTime };
+        const eventData: QwikSymbolEvent['detail'] = {
+          qBase,
+          qManifest,
+          qVersion,
+          href,
+          symbol,
+          element,
+          reqTime,
+        };
         if (isSync) {
           const hash = container.getAttribute('q:instance')!;
           handler = ((doc as any)['qFuncs_' + hash] || [])[Number.parseInt(symbol)];
@@ -126,6 +138,7 @@ type qWindow = Window & {
             error = new Error('sym:' + symbol);
           }
         } else {
+          emitEvent<QwikSymbolEvent>('qsymbol', eventData);
           const uri = url.href.split('#')[0];
           try {
             const module = import(/* @vite-ignore */ uri);
@@ -141,7 +154,11 @@ type qWindow = Window & {
           }
         }
         if (!handler) {
-          emitEvent('qerror', { importError, error, ...eventData });
+          emitEvent<QwikErrorEvent>('qerror', {
+            importError,
+            error,
+            ...eventData,
+          });
           console.error(error);
           // break out of the loop if handler is not found
           break;
@@ -150,14 +167,13 @@ type qWindow = Window & {
         if (element.isConnected) {
           try {
             doc.__q_context__ = [element, ev, url];
-            isSync || emitEvent<QwikSymbolEvent>('qsymbol', { ...eventData });
             const results = handler(ev, element);
             // only await if there is a promise returned
             if (isPromise(results)) {
               await results;
             }
           } catch (error) {
-            emitEvent('qerror', { error, ...eventData });
+            emitEvent<QwikErrorEvent>('qerror', { error, ...eventData });
           } finally {
             doc.__q_context__ = previousCtx;
           }
diff --git a/packages/qwik/src/qwikloader.unit.ts b/packages/qwik/src/qwikloader.unit.ts
diff --git a/packages/qwik/src/server/preload-impl.ts b/packages/qwik/src/server/preload-impl.ts
diff --git a/packages/qwik/src/server/qwik.server.api.md b/packages/qwik/src/server/qwik.server.api.md
diff --git a/packages/qwik/src/server/render.ts b/packages/qwik/src/server/render.ts
diff --git a/packages/qwik/src/server/types.ts b/packages/qwik/src/server/types.ts

Original file line number	Diff line number	Diff line change
`@@ -76,5 +76,7 @@ export default component$(() => {`
`76`	`76`
`77`	`77`	`export function collectSymbols() {`
`78`	`78`	`(window as any).symbols = [];`
`79`		`- document.addEventListener('qsymbol', (e) => (window as any).symbols.push((e as any).detail));`
	`79`	`+ document.addEventListener('qsymbol', (e) =>`
	`80`	`+ (window as any).symbols.push((e as any).detail.symbol)`
	`81`	`+ );`
`80`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,7 @@`
`166`	`166`	`}`
`167`	`167`	`],`
`168`	`168`	`"kind": "Interface",`
`169`		- "content": "```typescript\nexport interface RenderOptions extends SerializeDocumentOptions \n```\nExtends: [SerializeDocumentOptions](#serializedocumentoptions)\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[base?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\\| ((options: [RenderOptions](#renderoptions)<!-- -->) => string)\n\n\n</td><td>\n\n_(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.\n\n\n</td></tr>\n<tr><td>\n\n[containerAttributes?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord<string, string>\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[containerTagName?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_ When set, the app is serialized into a fragment. And the returned html is not a complete document. Defaults to `html`\n\n\n</td></tr>\n<tr><td>\n\n[locale?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\\| ((options: [RenderOptions](#renderoptions)<!-- -->) => string)\n\n\n</td><td>\n\n_(Optional)_ Language to use when rendering the document.\n\n\n</td></tr>\n<tr><td>\n\n[prefetchStrategy?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[PrefetchStrategy](#prefetchstrategy) \\\| null\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[preloader?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[PreloaderOptions](#preloaderoptions) \\\| boolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[qwikLoader?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[QwikLoaderOptions](#qwikloaderoptions)\n\n\n</td><td>\n\n_(Optional)_ Specifies if the Qwik Loader script is added to the document or not.\n\nDefaults to `{ include: true }`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[qwikPrefetchServiceWorker?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nQwikPrefetchServiceWorkerOptions\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[serverData?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord<string, any>\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[snapshot?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Defaults to `true`\n\n\n</td></tr>\n</tbody></table>",
	`169`	+ "content": "```typescript\nexport interface RenderOptions extends SerializeDocumentOptions \n```\nExtends: [SerializeDocumentOptions](#serializedocumentoptions)\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[base?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\\| ((options: [RenderOptions](#renderoptions)<!-- -->) => string)\n\n\n</td><td>\n\n_(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.\n\n\n</td></tr>\n<tr><td>\n\n[containerAttributes?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord<string, string>\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[containerTagName?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_ When set, the app is serialized into a fragment. And the returned html is not a complete document. Defaults to `html`\n\n\n</td></tr>\n<tr><td>\n\n[locale?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\\| ((options: [RenderOptions](#renderoptions)<!-- -->) => string)\n\n\n</td><td>\n\n_(Optional)_ Language to use when rendering the document.\n\n\n</td></tr>\n<tr><td>\n\n[prefetchStrategy?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[PrefetchStrategy](#prefetchstrategy) \\\| null\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[preloader?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[PreloaderOptions](#preloaderoptions) \\\| false\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[qwikLoader?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[QwikLoaderOptions](#qwikloaderoptions)\n\n\n</td><td>\n\n_(Optional)_ Specifies if the Qwik Loader script is added to the document or not.\n\nDefaults to `{ include: true }`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[qwikPrefetchServiceWorker?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nQwikPrefetchServiceWorkerOptions\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[serverData?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord<string, any>\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[snapshot?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Defaults to `true`\n\n\n</td></tr>\n</tbody></table>",
`170`	`170`	`"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",`
`171`	`171`	`"mdFile": "qwik.renderoptions.md"`
`172`	`172`	`},`
Original file line number	Diff line number	Diff line change
`@@ -2194,7 +2194,7 @@`
`2194`	`2194`	`}`
`2195`	`2195`	`],`
`2196`	`2196`	`"kind": "TypeAlias",`
`2197`		- "content": "Emitted by qwik-loader when a module was lazily loaded\n\n\n```typescript\nexport type QwikSymbolEvent = CustomEvent<{\n symbol: string;\n element: Element;\n reqTime: number;\n}>;\n```",
	`2197`	+ "content": "Emitted by qwik-loader when a module was lazily loaded\n\n\n```typescript\nexport type QwikSymbolEvent = CustomEvent<{\n symbol: string;\n element: Element;\n reqTime: number;\n qBase?: string;\n qManifest?: string;\n qVersion?: string;\n href?: string;\n}>;\n```",
`2198`	`2198`	`"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/render/jsx/types/jsx-qwik-events.ts",`
`2199`	`2199`	`"mdFile": "qwik.qwiksymbolevent.md"`
`2200`	`2200`	`},`