Class: Options

Constructor

new Options(otheropt)

Parameters:

Name	Type	Attributes	Description
`other`	Capabilities \| Map.<string, ?> \| Object	<optional>	Another set of capabilities to initialize this instance from.

Source: ie.js, line 91

Methods

addArguments(…args) → (non-null) {Options}

Specifies command-line switches to use when launching Internet Explorer. This is only valid when used with #forceCreateProcessApi.

Parameters:

Name	Type	Attributes	Description
`args`	string \| !Array.<string>	<repeatable>	The arguments to add.

Deprecated: Use #addBrowserCommandSwitches instead.
Source: ie.js, line 244

Returns:

A self reference.

Type:: Options

addBrowserCommandSwitches(…args) → (non-null) {Options}

Specifies command-line switches to use when launching Internet Explorer. This is only valid when used with #forceCreateProcessApi.

Parameters:

Name	Type	Attributes	Description
`args`	string \| !Array.<string>	<repeatable>	The arguments to add.

Source: ie.js, line 226

Returns:

A self reference.

Type:: Options

browserAttachTimeout(timeout) → (non-null) {Options}

Configures the timeout, in milliseconds, that the driver will attempt to located and attach to a newly opened instance of Internet Explorer. The default is zero, which indicates waiting indefinitely.

Parameters:

Name	Type	Description
`timeout`	number	How long to wait for IE.

Source: ie.js, line 199

Returns:

A self reference.

Type:: Options

enableElementCacheCleanup(enable) → (non-null) {Options}

Configures whether the driver should attempt to remove obsolete WebElements from its internal cache on page navigation (true by default). Disabling this option will cause the driver to run with a larger memory footprint.

Parameters:

Name	Type	Description
`enable`	boolean	Whether to enable element reference cleanup.

Source: ie.js, line 172

Returns:

A self reference.

Type:: Options

enablePersistentHover(enable) → (non-null) {Options}

Configures whether to enable persistent mouse hovering (true by default). Persistent hovering is achieved by continuously firing mouse over events at the last location the mouse cursor has been moved to.

Parameters:

Name	Type	Description
`enable`	boolean	Whether to enable persistent hovering.

Source: ie.js, line 158

Returns:

A self reference.

Type:: Options

ensureCleanSession(cleanSession) → (non-null) {Options}

Configures whether to clear the cache, cookies, history, and saved form data before starting the browser. Using this capability will clear session data for all running instances of Internet Explorer, including those started manually.

Parameters:

Name	Type	Description
`cleanSession`	boolean	Whether to clear all session data on startup.

Source: ie.js, line 275

Returns:

A self reference.

Type:: Options

fileUploadDialogTimeout(timeout) → (non-null) {Options}

The options File Upload Dialog Timeout in milliseconds

Parameters:

Name	Type	Description
`timeout`	number	How long to wait for IE.

Source: ie.js, line 336

Returns:

A self reference.

Type:: Options

forceCreateProcessApi(force) → (non-null) {Options}

Configures whether to launch Internet Explorer using the CreateProcess API. If this option is not specified, IE is launched using IELaunchURL, if available. For IE 8 and above, this option requires the TabProcGrowth registry value to be set to 0.

Parameters:

Name	Type	Description
`force`	boolean	Whether to use the CreateProcess API.

Source: ie.js, line 213

Returns:

A self reference.

Type:: Options

ignoreZoomSetting(ignore) → (non-null) {Options}

Indicates whether to skip the check that the browser's zoom level is set to 100%.

Parameters:

Name	Type	Description
`ignore`	boolean	Whether to ignore the browser's zoom level settings.

Source: ie.js, line 130

Returns:

A self reference.

Type:: Options

initialBrowserUrl(url) → (non-null) {Options}

Sets the initial URL loaded when IE starts. This is intended to be used with #introduceFlakinessByIgnoringProtectedModeSettings to allow the user to initialize IE in the proper Protected Mode zone. Setting this option may cause browser instability or flaky and unresponsive code. Only "best effort" support is provided when using this option.

Parameters:

Name	Type	Description
`url`	string	The initial browser URL.

Source: ie.js, line 145

Returns:

A self reference.

Type:: Options

introduceFlakinessByIgnoringProtectedModeSettings(ignoreSettings) → (non-null) {Options}

Whether to disable the protected mode settings check when the session is created. Disabling this setting may lead to significant instability as the browser may become unresponsive/hang. Only "best effort" support is provided when using this capability.

For more information, refer to the IEDriver's required system configuration.

Parameters:

Name	Type	Description
`ignoreSettings`	boolean	Whether to ignore protected mode settings.

Source: ie.js, line 118

Returns:

A self reference.

Type:: Options

requireWindowFocus(require) → (non-null) {Options}

Configures whether to require the IE window to have input focus before performing any user interactions (i.e. mouse or keyboard events). This option is disabled by default, but delivers much more accurate interaction events when enabled.

Parameters:

Name	Type	Description
`require`	boolean	Whether to require window focus.

Source: ie.js, line 186

Returns:

A self reference.

Type:: Options

setEdgeChromium(attachEdgeChromium) → (non-null) {Options}

Sets the IEDriver to drive Chromium-based Edge in Internet Explorer mode.

Parameters:

Name	Type	Description
`attachEdgeChromium`	boolean	Whether to run in Chromium-based-Edge in IE mode

Source: ie.js, line 357

Returns:

A self reference.

Type:: Options

setEdgePath(path) → (non-null) {Options}

Sets the path of the EdgeChromium driver.

Parameters:

Name	Type	Description
`path`	string	The EdgeChromium driver path.

Source: ie.js, line 346

Returns:

A self reference.

Type:: Options

setExtractPath(path) → (non-null) {Options}

Sets the path of the temporary data directory to use.

Parameters:

Name	Type	Description
`path`	string	The log file path.

Source: ie.js, line 315

Returns:

A self reference.

Type:: Options

setHost(host) → (non-null) {Options}

Sets the IP address of the driver's host adapter.

Parameters:

Name	Type	Description
`host`	string	The IP address to use.

Source: ie.js, line 305

Returns:

A self reference.

Type:: Options

setLogFile(file) → (non-null) {Options}

Sets the path to the log file the driver should log to.

Parameters:

Name	Type	Description
`file`	string	The log file path.

Source: ie.js, line 285

Returns:

A self reference.

Type:: Options

setLogLevel(level) → (non-null) {Options}

Sets the IEDriverServer's logging level.

Parameters:

Name	Type	Description
`level`	Level	The logging level.

Source: ie.js, line 295

Returns:

A self reference.

Type:: Options

setScrollBehavior(behavior) → (non-null) {Options}

Sets how elements should be scrolled into view for interaction.

Parameters:

Name	Type	Description
`behavior`	number	The desired scroll behavior: either 0 to align with the top of the viewport or 1 to align with the bottom.

Source: ie.js, line 368

Returns:

A self reference.

Type:: Options

silent(silent) → (non-null) {Options}

Sets whether the driver should start in silent mode.

Parameters:

Name	Type	Description
`silent`	boolean	Whether to run in silent mode.

Source: ie.js, line 325

Returns:

A self reference.

Type:: Options

usePerProcessProxy(enable) → (non-null) {Options}

Configures whether proxies should be configured on a per-process basis. If not set, setting a proxy will configure the system proxy. The default behavior is to use the system proxy.

Parameters:

Name	Type	Description
`enable`	boolean	Whether to enable per-process proxy settings.

Source: ie.js, line 261

Returns:

A self reference.

Type:: Options