setProxy method
Use this method to configure Eyes so that it will interact with the Eyes server via a proxy.
By default, the SDK interacts directly with the Eyes server. If necessary, you can define a proxy server so that the SDK will interact with the proxy server, and the proxy server will relay the interaction to the Eyes server.
Syntax
let configval = config.setProxy(value);
Parameters
- value
- Type:
ProxySettings|ProxySettingsObject|string|boolean - An object created from the ProxySettings class that contains the user name, password, URI and port.
Type definitions
- ProxySettingsObject
- The type ProxySettingsObject is defined as: {url:string,username:(string|undefined),password:(string|undefined)}.
Return value
- Type: Configuration
-
The value returned is the object that called the method.
This allows you to use a fluent style to call the
setXXXXmethods of the Configuration class.