Skip to main content

AdminUiAppConfig

AdminUiAppConfig​

@vendure/commonshared-types.ts

Configures the path to a custom-build of the Admin UI app.

Signature
interface AdminUiAppConfig {
    path: string;
    route?: string;
    compile?: () => Promise<void>;
}

path​

property
string

The path to the compiled admin UI app files. If not specified, an internal default build is used. This path should contain the vendure-ui-config.json file, index.html, the compiled js bundles etc.

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.