Skip to content

Waku / server: WakuCatalogDeliveryOptions

Functions, types, and exports for Waku / server: WakuCatalogDeliveryOptions.

Page outline
import type { WakuCatalogDeliveryOptions } from "@palamedes/waku/server"

type WakuCatalogDeliveryOptions = {
    /**
     * Built Vite client directory containing palamedes-split-manifest.json.
     * Defaults to Waku's `dist/public` in the process working directory.
     */
    clientDirectory?: string;
    /** Resolve the application-owned locale policy from the original request. */
    resolveLocale: (request: Request) => string;
    /**
     * Allow running before a client build exists in development. Defaults to
     * whether Vite built the server as a development build
     * (`import.meta.env.DEV`), not to the runtime `NODE_ENV`.
     */
    development?: boolean;
    /** Override the generated manifest filename for a custom Vite output. */
    manifestName?: string;
    /** Optional trusted catalog-free host UI for failed delivery. */
    errorHtml?: string;
    /**
     * CSP nonce for the generated import map and failure probe: a fixed string,
     * or a resolver called once per HTML document request.
     */
    nonce?: string | WakuNonceResolver;
};

Properties

NameTypeRequiredDescription
clientDirectorystringNoBuilt Vite client directory containing palamedes-split-manifest.json.
Defaults to Waku's dist/public in the process working directory.
resolveLocale(request: Request) => stringYesResolve the application-owned locale policy from the original request.
developmentbooleanNoAllow running before a client build exists in development. Defaults to
whether Vite built the server as a development build
(import.meta.env.DEV), not to the runtime NODE_ENV.
manifestNamestringNoOverride the generated manifest filename for a custom Vite output.
errorHtmlstringNoOptional trusted catalog-free host UI for failed delivery.
noncestring | WakuNonceResolverNoCSP nonce for the generated import map and failure probe: a fixed string,
or a resolver called once per HTML document request.

Source entry on GitHub

Last updated: November 1, 2026