AdminUiOptions

AdminUiOptions

Documentation generated from admin-ui-plugin.ts on Mar 14 2019 at 20:14

Configuration options for the AdminUiPlugin.

Signature

interface AdminUiOptions {
  hostname?: string;
  port: number;
  apiHost?: string | 'auto';
  apiPort?: number | 'auto';
}

Members

hostname

property
type:
string
default:
'localhost'

The hostname of the server serving the static admin ui files.

port

property
type:
number

The port on which the server will listen.

apiHost

property
type:
string | 'auto'
default:
'auto'

The hostname of the Vendure server which the admin ui will be making API calls to. If set to “auto”, the admin ui app will determine the hostname from the current location (i.e. window.location.hostname).

apiPort

property
type:
number | 'auto'
default:
'auto'

The port of the Vendure server which the admin ui will be making API calls to. If set to “auto”, the admin ui app will determine the port from the current location (i.e. window.location.port).

alpha