Class Options

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'.

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.

Sets the name of the activity hosting a Chrome-based Android WebView. This option must be set to connect to an Android WebView

Configures the ChromeDriver to launch Chrome on Android via adb. This function is shorthand for #androidPackage options.androidPackage('com.android.chrome').

Sets the device serial number to connect to via ADB. If not specified, the ChromeDriver will select an unused device at random. An error will be returned if all devices already have active sessions.

Sets the package name of the Chrome or WebView app.

Sets the process name of the Activity hosting the WebView (as given by ps). If not specified, the process name is assumed to be the same as #androidPackage.

Sets whether to connect to an already-running instead of the specified #androidProcess app instead of launching the app with a clean data directory.

Sets the address of a Chromium remote debugging server to connect to. Address should be of the form "{hostname|IP address}:port" (e.g. "localhost:9222").

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

List of Chrome command line switches to exclude that ChromeDriver by default passes when starting Chrome. Do not prefix switches with '--'.

Configures the chromedriver to start Chrome in headless mode.

NOTE: Resizing the browser window in headless mode is only supported in Chrome 60. Users are encouraged to set an initial window size with the #windowSize windowSize({width, height)} option.

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.

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

Sets the directory to store Chrome minidumps in. This option is only supported when ChromeDriver is running on Linux.

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

Configures Chrome to emulate a mobile device. For more information, refer to the ChromeDriver project page on mobile emulation. Configuration options include:

• deviceName: The name of a pre-configured emulated device
• width: screen width, in pixels
• height: screen height, in pixels
• pixelRatio: screen pixel ratio

Example 1: Using a Pre-configured Device

let options = new chrome.Options().setMobileEmulation(
    {deviceName: 'Google Nexus 5'});

let driver = new chrome.Driver(options);
Copy

Example 2: Using Custom Screen Configuration

let options = new chrome.Options().setMobileEmulation({
    width: 360,
    height: 640,
    pixelRatio: 3.0
});

let driver = new chrome.Driver(options);
Copy

Sets the performance logging preferences. Options include:

• enableNetwork: Whether or not to collect events from Network domain.
• enablePage: Whether or not to collect events from Page domain.
• enableTimeline: Whether or not to collect events from Timeline domain. Note: when tracing is enabled, Timeline domain is implicitly disabled, unless enableTimeline is explicitly set to true.
• tracingCategories: A comma-separated string of Chrome tracing categories for which trace events should be collected. An unspecified or empty string disables tracing.
• bufferUsageReportingInterval: The requested number of milliseconds between DevTools trace buffer usage events. For example, if 1000, then once per second, DevTools will report how full the trace buffer is. If a report indicates the buffer usage is 100%, a warning will be issued.

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

Sets the initial window size.

Throws

if width or height is unspecified, not a number, or less than or equal to 0.

Extracts the ChromeDriver specific options from the given capabilities object.