selenium-webdriver

Version:

The official WebDriver JavaScript bindings from the Selenium project

90 lines (87 loc) • 8.52 kB

HTML

<!DOCTYPE html><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>selenium-webdriver/chrome</title><link href="dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article><div class="codelink"><a href="source/chrome.js.src.html#l115">View Source</a></div><h1>module selenium-webdriver/chrome</h1><p>Defines a <a href="module_selenium-webdriver_chrome_class_Driver.html">WebDriver</a> client for the Chrome web browser. Before using this module, you must download the latest <a href="http://chromedriver.storage.googleapis.com/index.html">ChromeDriver release</a> and ensure it can be found on your system <a href="http://en.wikipedia.org/wiki/PATH_%28variable%29">PATH</a>.</p> <p>There are three primary classes exported by this module:</p> <ol><li> <p><a href="module_selenium-webdriver_chrome_class_ServiceBuilder.html">ServiceBuilder</a>: configures the <a href="module_selenium-webdriver_remote_class_DriverService.html"><code>remote.DriverService</code></a> that manages the <a href="https://sites.google.com/a/chromium.org/chromedriver/">ChromeDriver</a> child process.</p> </li><li> <p><a href="module_selenium-webdriver_chrome_class_Options.html">Options</a>: defines configuration options for each new Chrome session, such as which <a href="module_selenium-webdriver_chrome_class_Options.html#setProxy">proxy</a> to use, what <a href="module_selenium-webdriver_chrome_class_Options.html#addExtensions">extensions</a> to install, or what <a href="module_selenium-webdriver_chrome_class_Options.html#addArguments">command-line switches</a> to use when starting the browser.</p> </li><li> <p><a href="module_selenium-webdriver_chrome_class_Driver.html">Driver</a>: the WebDriver client; each new instance will control a unique browser session with a clean user profile (unless otherwise configured through the <a href="module_selenium-webdriver_chrome_class_Options.html"><code>Options</code></a> class).</p> </li></ol> <p><strong>Customizing the ChromeDriver Server</strong> <a id="custom-server"></a></p> <p>By default, every Chrome session will use a single driver service, which is started the first time a <a href="module_selenium-webdriver_chrome_class_Driver.html"><code>Driver</code></a> instance is created and terminated when this process exits. The default service will inherit its environment from the current process and direct all output to /dev/null. You may obtain a handle to this default service using <a href="module_selenium-webdriver_chrome.html#getDefaultService"><code>getDefaultService()</code></a> and change its configuration with <a href="module_selenium-webdriver_chrome.html#setDefaultService"><code>setDefaultService()</code></a>.</p> <p>You may also create a <a href="module_selenium-webdriver_chrome_class_Driver.html"><code>Driver</code></a> with its own driver service. This is useful if you need to capture the server's log output for a specific session:</p> <pre><code>var chrome = require('selenium-webdriver/chrome'); var service = new chrome.ServiceBuilder() .loggingTo('/my/log/file.txt') .enableVerboseLogging() .build(); var options = new chrome.Options(); // configure browser options ... var driver = new chrome.Driver(options, service); </code></pre> <p>Users should only instantiate the <a href="module_selenium-webdriver_chrome_class_Driver.html"><code>Driver</code></a> class directly when they need a custom driver service configuration (as shown above). For normal operation, users should start Chrome using the <a href="module_selenium-webdriver_class_Builder.html"><code>selenium-webdriver.Builder</code></a>.</p> <p><strong>Working with Android</strong> <a id="android"></a></p> <p>The <a href="https://sites.google.com/a/chromium.org/chromedriver/getting-started/getting-started---android">ChromeDriver</a> supports running tests on the Chrome browser as well as <a href="https://developer.chrome.com/multidevice/webview/overview">WebView apps</a> starting in Android 4.4 (KitKat). In order to work with Android, you must first start the adb</p> <pre><code>adb start-server </code></pre> <p>By default, adb will start on port 5037. You may change this port, but this will require configuring a <a href="#custom-server">custom server</a> that will connect to adb on the <a href="module_selenium-webdriver_chrome_class_ServiceBuilder.html#setAdbPort">correct port</a>:</p> <pre><code>var service = new chrome.ServiceBuilder() .setAdbPort(1234) build(); // etc. </code></pre> <p>The ChromeDriver may be configured to launch Chrome on Android using <a href="module_selenium-webdriver_chrome_class_Options.html#androidChrome"><code>Options#androidChrome()</code></a>:</p> <pre><code>var driver = new Builder() .forBrowser('chrome') .setChromeOptions(new chrome.Options().androidChrome()) .build(); </code></pre> <p>Alternatively, you can configure the ChromeDriver to launch an app with a Chrome-WebView by setting the <a href="module_selenium-webdriver_chrome_class_Options.html#androidActivity">androidActivity</a> option:</p> <pre><code>var driver = new Builder() .forBrowser('chrome') .setChromeOptions(new chrome.Options() .androidPackage('com.example') .androidActivity('com.example.Activity')) .build(); </code></pre> <p>[Refer to the ChromeDriver site] for more information on using the <a href="https://sites.google.com/a/chromium.org/chromedriver/getting-started/getting-started---android">ChromeDriver with Android</a>.</p> <h2>Functions</h2><div id="getDefaultService" class="function"><div><h3>getDefaultService()<span class="codelink"><a href="source/chrome.js.src.html#l847">code »</a></span></h3><p>Returns the default ChromeDriver service. If such a service has not been configured, one will be constructed using the default configuration for a ChromeDriver executable found on the system PATH.</p> <div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_remote_class_DriverService.html">DriverService</a></code><dd><p>The default ChromeDriver service.</p> </dl></div></div></div></div><hr class="fn-sep"><div id="setDefaultService" class="function"><div><h3>setDefaultService(<wbr>service)<span class="codelink"><a href="source/chrome.js.src.html#l848">code »</a></span></h3><p>Sets the default service to use for new ChromeDriver instances.</p> <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>service<code><a href="module_selenium-webdriver_remote_class_DriverService.html">DriverService</a></code><dd><p>The service to use.</p> </dl></div><div class="fn-details"><div><b>Throws</b></div><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a></code><dd><p>If the default service is currently running.</p> </dl></div></div></div></div><h2>Types</h2><dl><dt><a href="module_selenium-webdriver_chrome_class_Driver.html">Driver</a><dd><p>Creates a new WebDriver client for Chrome.</p> <dt><a href="module_selenium-webdriver_chrome_class_Options.html">Options</a><dd><p>Class for managing ChromeDriver specific options.</p> <dt><a href="module_selenium-webdriver_chrome_class_ServiceBuilder.html">ServiceBuilder</a><dd><p>Creates <a href="module_selenium-webdriver_remote_class_DriverService.html"><code>selenium-webdriver/remote.DriverService</code></a> instances that manage a <a href="https://sites.google.com/a/chromium.org/chromedriver/">ChromeDriver</a> server in a child process.</p> </dl></article><nav><h3><a href="index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="types.js"></script><script src="dossier.js"></script>