class Options

webdriver.Serializable
  └ Options

Class for managing ChromeDriver specific options.

Instance Methods

addArguments(var_args)code »

Add additional command line arguments to use when launching the Chrome browser. Each argument may be specified with or without the "--" prefix (e.g. "--foo" and "foo"). Arguments with an associated value should be delimited by an "=": "foo=bar".

Parameters
var_args...(string|Array<string>)

The arguments to add.

Returns
Options

A self reference.


addExtensions(var_args)code »

Add additional extensions to install when launching Chrome. Each extension should be specified as the path to the packed CRX file, or a Buffer for an extension.

Parameters
var_args...(string|Buffer|Array<(string|Buffer)>)

The extensions to add.

Returns
Options

A self reference.


detachDriver(detach)code »

Sets whether to leave the started Chrome browser running if the controlling ChromeDriver service is killed before webdriver.WebDriver#quit() is called.

Parameters
detachboolean

Whether to leave the browser running if the chromedriver service is killed before the session.

Returns
Options

A self reference.


serialize()code »

Converts this instance to its JSON wire protocol representation. Note this function is an implementation not intended for general use.

Overrides: webdriver.Serializable

Returns
{args: Array<string>, binary: (string|undefined), detach: boolean, extensions: Array<(string|webdriver.promise.Promise)>, localState: ?(Object), logPath: (string|undefined), prefs: ?(Object)}

The JSON wire protocol representation of this instance.


setChromeBinaryPath(path)code »

Sets the path to the Chrome binary to use. On Mac OS X, this path should reference the actual Chrome executable, not just the application binary (e.g. "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome").

The binary path be absolute or relative to the chromedriver server executable, but it must exist on the machine that will launch Chrome.

Parameters
pathstring

The path to the Chrome binary to use.

Returns
Options

A self reference.


setChromeLogFile(path)code »

Sets the path to Chrome's log file. This path should exist on the machine that will launch Chrome.

Parameters
pathstring

Path to the log file to use.

Returns
Options

A self reference.


setLocalState(state)code »

Sets preferences for the "Local State" file in Chrome's user data directory.

Parameters
stateObject

Dictionary of local state preferences.

Returns
Options

A self reference.


setLoggingPrefs(prefs)code »

Sets the logging preferences for the new session.

Parameters
prefswebdriver.logging.Preferences

The logging preferences.

Returns
Options

A self reference.


setProxy(proxy)code »

Sets the proxy settings for the new session.

Parameters
proxyselenium-webdriver.ProxyConfig

The proxy configuration to use.

Returns
Options

A self reference.


setUserPreferences(prefs)code »

Sets the user preferences for Chrome's user profile. See the "Preferences" file in Chrome's user data directory for examples.

Parameters
prefsObject

Dictionary of user preferences to use.

Returns
Options

A self reference.


toCapabilities(opt_capabilities)code »

Converts this options instance to a webdriver.Capabilities object.

Parameters
opt_capabilities?Capabilities=

The capabilities to merge these options into, if any.

Returns
webdriver.Capabilities

The capabilities.

Static Functions

Options.fromCapabilities(capabilities)code »

Extracts the ChromeDriver specific options from the given capabilities object.

Parameters
capabilitieswebdriver.Capabilities

The capabilities object.

Returns
Options

The ChromeDriver options.