@qwik.dev/core 2.0.0-beta.11 → 2.0.0-beta.13

package/dist/server.d.ts

@@ -245,18 +245,12 @@ declare interface QwikBundle {
 declare type QwikBundleGraph = Array<string | number>;
 
 /** @public */
-export declare interface QwikLoaderOptions {
-    /**
-     * Whether to include the qwikloader script in the document. Normally you don't need to worry
-     * about this, but in case of multi-container apps using different Qwik versions, you might want
-     * to only enable it on one of the containers.
-     *
-     * Defaults to `'auto'`.
-     */
+export declare type QwikLoaderOptions = 'module' | 'inline' | 'never' | {
+    /** @deprecated No longer used. */
     include?: 'always' | 'never' | 'auto';
-    /** @deprecated No longer used, the qwikloader is always loaded as soon as possible */
+    /** @deprecated No longer used. */
     position?: 'top' | 'bottom';
-}
+};
 
 /**
  * The metadata of the build. One of its uses is storing where QRL symbols are located.
@@ -351,11 +345,25 @@ export declare interface RenderOptions extends SerializeDocumentOptions {
     /** Language to use when rendering the document. */
     locale?: string | ((options: RenderOptions) => string);
     /**
-     * Specifies if the Qwik Loader script is added to the document or not.
+     * Specifies how the Qwik Loader is included in the document. This enables interactivity and lazy
+     * loading.
+     *
+     * `module`: Use a `<script>` tag to load the Qwik Loader. Subsequent page loads will have the
+     * script cached and instantly running.
+     *
+     * `inline`: This embeds the Qwik Loader script directly in the document. This adds about 3kB
+     * before compression, which typically is reduced to about 1.6kB with gzip.
+     *
+     * `never`: Do not include the Qwik Loader script. This is mostly useful when embedding multiple
+     * containers on the same page.
+     *
+     * Defaults to `module`.
      *
-     * Defaults to `{ include: true }`.
+     * Note that the Qwik Loader is absolutely required for Qwik to work. There must be an instance of
+     * it loaded for any interactivity to happen.
      */
     qwikLoader?: QwikLoaderOptions;
+    /** Specifies how preloading is handled. This ensures that code is instantly available when needed. */
     preloader?: PreloaderOptions | false;
     /** @deprecated Use `preloader` instead */
     prefetchStrategy?: PrefetchStrategy | null;