effex-monorepo
    Preparing search index...

    Interface EffexPlatformOptions

    Options for the Effex Platform Vite plugin.

    interface EffexPlatformOptions {
        entry?: string;
        exclude?: RegExp;
        include?: RegExp;
        mode?: "ssr" | "ssg";
    }
    Index

    Properties

    entry? exclude? include? mode?

    Properties

    Optional Readonlyentry

    entry?: string

    Path to the SSR/SSG entry module.

    In SSR mode: exports a render(request: Request) => Promise<Response> function. In SSG mode: exports { router, app?, document?, layers? } for static site generation.

    When provided, the plugin runs an SSR dev server with HMR in dev mode. When omitted, only the server-code stripping transform is applied.

    "src/vite-entry.ts"
    exclude?: RegExp

    File patterns to exclude from the transform.

    include?: RegExp

    File patterns to apply the server-code stripping transform to. Defaults to all .ts/.tsx/.js/.jsx files.

    mode?: "ssr" | "ssg"

    Build mode.

    • "ssr" (default) — Standard SSR with live server
    • "ssg" — Static site generation. After vite build, runs Platform.buildStaticSite() to pre-render all Route.static routes.

    In dev mode, both modes behave the same (SSR dev server with HMR).

    Settings

    Member Visibility

    On This Page

    Properties