Skip to main content

AdminUiAppDevModeConfig

AdminUiAppDevModeConfig​

@vendure/commonshared-types.ts

Information about the Admin UI app dev server.

Signature
interface AdminUiAppDevModeConfig {
    sourcePath: string;
    port: number;
    route?: string;
    compile: () => Promise<void>;
}

sourcePath​

property
string

The path to the uncompiled UI app source files. This path should contain the vendure-ui-config.json file.

port​

property
number

The port on which the dev server is listening. Overrides the value set by AdminUiOptions.port.

route​

property
string
default:
'admin'

Specifies the url route to the Admin UI app.

compile​

property
() => Promise<void>

The function which will be invoked to start the app compilation process.