Interface IServiceConfig

interface IServiceConfig {
    basicAuth: boolean;
    controllerUrl: string;
    password?: string;
    requestHeaders?: {
        [key: string]: string;
    };
    timeout: number;
    username?: string;
    [key: string]: unknown;
}

Hierarchy (view full)

Indexable

  • [key: string]: unknown

    Configurations might contain any other values/keys, that do not conflict with valid configuration parameters.

Properties

basicAuth: boolean

Enable HTTP basic auth.

controllerUrl: string

Controller URL must be a valid URL string with leading protocol scheme (e.g. 'http://') and should point to the ProCon.IP HTTP root. This address will be combined with the endpoint (e.g. "/GetState.csv") to build the request address. A trailing slash will be added automatically if needed.

password?: string

HTTP basic auth pass. Optional.

requestHeaders?: {
    [key: string]: string;
}
timeout: number

Define request timeout.

username?: string

HTTP basic auth username. Optional.