@happy-dom/server-renderer/lib/types/IOptionalServerRendererConfiguration.d.ts

Use Happy DOM for server-side rendering (SSR) or as a static site generator (SSG).

import type IOptionalBrowserSettings from 'happy-dom/lib/browser/types/IOptionalBrowserSettings.js';
import ServerRendererLogLevelEnum from '../enums/ServerRendererLogLevelEnum.js';
import IServerRendererItem from './IServerRendererItem.js';
export default interface IOptionalServerRendererConfiguration {
    /**
     * Settings for the browser.
     */
    browser?: IOptionalBrowserSettings;
    /**
     * Log level for the server renderer.
     */
    logLevel?: ServerRendererLogLevelEnum;
    /**
     * Enables debugging. This will override "browser.debug.traceWaitUntilComplete".
     */
    debug?: boolean;
    /**
     * Enables inspector.
     */
    inspect?: boolean;
    /**
     * Shows help information and exits.
     */
    help?: boolean;
    /**
     * Output directory.
     */
    outputDirectory?: string;
    /**
     * Cache settings.
     */
    cache?: {
        /**
         * Disables all caching.
         */
        disable?: boolean;
        /**
         * Directory for caching files.
         */
        directory?: string;
        /**
         * Warm up by rendering the first item before rendering the rest.
         */
        warmup?: boolean;
    };
    /**
     * Settings for the worker.
     */
    worker?: {
        /**
         * Disables the worker.
         */
        disable?: boolean;
        /**
         * Maximum concurrency for the worker.
         */
        maxConcurrency?: number;
    };
    /**
     * Settings for rendering.
     */
    render?: {
        /**
         * Maximum concurrency for rendering.
         */
        maxConcurrency?: number;
        /**
         * Timeout for rendering in milliseconds.
         */
        timeout?: number;
        /**
         * Use incognito context for rendering.
         */
        incognitoContext?: boolean;
        /**
         * Render shadow roots with the "serializable" option set to true.
         */
        serializableShadowRoots?: boolean;
        /**
         * Render all shadow roots, including those that are not serializable.
         */
        allShadowRoots?: boolean;
        /**
         * Tags to exclude from shadow root rendering.
         */
        excludeShadowRootTags?: string[] | null;
        /**
         * Disable polyfills used for unimplemented functionality.
         */
        disablePolyfills?: boolean;
    };
    /**
     * List of URLs to render.
     */
    urls?: Array<string | IServerRendererItem> | null;
    /**
     * Proxy server settings.
     */
    server?: {
        start?: boolean;
        serverURL?: string;
        targetOrigin?: string | null;
        disableCache?: boolean;
        disableCacheQueue?: boolean;
        cacheTime?: number;
    };
}
//# sourceMappingURL=IOptionalServerRendererConfiguration.d.ts.map