Cell API
    Preparing search index...

    Interface CellPluginOptions

    interface CellPluginOptions {
        disabled?: string[];
        entry?: Partial<Record<Target, string>>;
        entryName?: string;
        env?: Record<string, string | undefined>;
        external?: string[];
        extraModules?: ExtraModule[];
        format?: "esm" | "cjs";
        mode?: string[];
        outDir?: string;
        preset?: string;
        root?: string;
        runtime?: any;
        runtimeDisabled?: string[];
        single?: boolean;
        sourcemap?: boolean;
        targets?: Target[];
    }

    Hierarchy (View Summary)

    Index
    disabled? entry? entryName? env? external? extraModules? format? mode? outDir? preset? root? runtime? runtimeDisabled? single? sourcemap? targets?
    disabled?: string[]

    Components left out entirely, with the dependencies only they lead to ('!name' in cell.config.ts).

    Optionalentry

    entry?: Partial<Record<Target, string>>

    Explicit entry specifiers; they win over entryName.

    entryName?: string

    Name of the backend entry to pick from the components' entries (chosen by the preset, e.g. http).

    env?: Record<string, string | undefined>

    Environment for ${env.*} in frontend configuration and CELL_FRONTEND__ / CELL_BACKEND__ overrides. Default: process.env.

    external?: string[]

    Packages the server bundle must not inline; they are copied into server/node_modules.

    extraModules?: ExtraModule[]

    DI modules added by toolchain modules, loaded after the components' own (cell.addRuntimeModule).

    format?: "esm" | "cjs"

    Server bundle format. Default esm (server/index.mjs); cjs emits server/index.cjs.

    mode?: string[]

    Active modes, in order; later modes override earlier ones.

    outDir?: string

    Output directory, relative to the project root. Default .cell/output.

    preset?: string

    Name of the preset that chose the options, recorded in manifest.json.

    root?: string
    runtime?: any

    Runtime of the server bundle. Default node. workerd (Cloudflare Workers) has no import.meta.url / dirname / filename: the bundle uses WORKERD_SERVER_FILE instead.

    runtimeDisabled?: string[]

    Components whose DI modules are left out; their configuration still applies.

    single?: boolean

    Embed the frontend in the server bundle (cell build --single): the server serves it from memory, and the output has no public directory. Only with both targets.

    sourcemap?: boolean
    targets?: Target[]

    Targets to build; default: backend plus the components' targets.

    Settings
    Member Visibility

    On This Page
    Properties