Skip to content
Navigation Menu
{{ message }}
forked from browserstack/selenium-webdriver-nodejs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathchrome.js.src.html
More file actions
1 lines (1 loc) · 36.1 KB
/
Copy pathchrome.js.src.html
File metadata and controls
1 lines (1 loc) · 36.1 KB
1
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>chrome.js</title><link href="../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>chrome.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2013 Selenium committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2013 Software Freedom Conservancy<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the "License");<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an "AS IS" BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>'use strict';<tr><td><a name="l17" href="#l17">17</a><td><tr><td><a name="l18" href="#l18">18</a><td>var fs = require('fs'),<tr><td><a name="l19" href="#l19">19</a><td> util = require('util');<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>var webdriver = require('./index'),<tr><td><a name="l22" href="#l22">22</a><td> executors = require('./executors'),<tr><td><a name="l23" href="#l23">23</a><td> io = require('./io'),<tr><td><a name="l24" href="#l24">24</a><td> portprober = require('./net/portprober'),<tr><td><a name="l25" href="#l25">25</a><td> remote = require('./remote');<tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td><tr><td><a name="l28" href="#l28">28</a><td>/**<tr><td><a name="l29" href="#l29">29</a><td> * Name of the ChromeDriver executable.<tr><td><a name="l30" href="#l30">30</a><td> * @type {string}<tr><td><a name="l31" href="#l31">31</a><td> * @const<tr><td><a name="l32" href="#l32">32</a><td> */<tr><td><a name="l33" href="#l33">33</a><td>var CHROMEDRIVER_EXE =<tr><td><a name="l34" href="#l34">34</a><td> process.platform === 'win32' ? 'chromedriver.exe' : 'chromedriver';<tr><td><a name="l35" href="#l35">35</a><td><tr><td><a name="l36" href="#l36">36</a><td><tr><td><a name="l37" href="#l37">37</a><td>/**<tr><td><a name="l38" href="#l38">38</a><td> * Creates {@link remote.DriverService} instances that manage a ChromeDriver<tr><td><a name="l39" href="#l39">39</a><td> * server.<tr><td><a name="l40" href="#l40">40</a><td> * @param {string=} opt_exe Path to the server executable to use. If omitted,<tr><td><a name="l41" href="#l41">41</a><td> * the builder will attempt to locate the chromedriver on the current<tr><td><a name="l42" href="#l42">42</a><td> * PATH.<tr><td><a name="l43" href="#l43">43</a><td> * @throws {Error} If provided executable does not exist, or the chromedriver<tr><td><a name="l44" href="#l44">44</a><td> * cannot be found on the PATH.<tr><td><a name="l45" href="#l45">45</a><td> * @constructor<tr><td><a name="l46" href="#l46">46</a><td> */<tr><td><a name="l47" href="#l47">47</a><td>var ServiceBuilder = function(opt_exe) {<tr><td><a name="l48" href="#l48">48</a><td> /** @private {string} */<tr><td><a name="l49" href="#l49">49</a><td> this.exe_ = opt_exe || io.findInPath(CHROMEDRIVER_EXE, true);<tr><td><a name="l50" href="#l50">50</a><td> if (!this.exe_) {<tr><td><a name="l51" href="#l51">51</a><td> throw Error(<tr><td><a name="l52" href="#l52">52</a><td> 'The ChromeDriver could not be found on the current PATH. Please ' +<tr><td><a name="l53" href="#l53">53</a><td> 'download the latest version of the ChromeDriver from ' +<tr><td><a name="l54" href="#l54">54</a><td> 'http://chromedriver.storage.googleapis.com/index.html and ensure ' +<tr><td><a name="l55" href="#l55">55</a><td> 'it can be found on your PATH.');<tr><td><a name="l56" href="#l56">56</a><td> }<tr><td><a name="l57" href="#l57">57</a><td><tr><td><a name="l58" href="#l58">58</a><td> if (!fs.existsSync(this.exe_)) {<tr><td><a name="l59" href="#l59">59</a><td> throw Error('File does not exist: ' + this.exe_);<tr><td><a name="l60" href="#l60">60</a><td> }<tr><td><a name="l61" href="#l61">61</a><td><tr><td><a name="l62" href="#l62">62</a><td> /** @private {!Array.<string>} */<tr><td><a name="l63" href="#l63">63</a><td> this.args_ = [];<tr><td><a name="l64" href="#l64">64</a><td> this.stdio_ = 'ignore';<tr><td><a name="l65" href="#l65">65</a><td>};<tr><td><a name="l66" href="#l66">66</a><td><tr><td><a name="l67" href="#l67">67</a><td><tr><td><a name="l68" href="#l68">68</a><td>/** @private {number} */<tr><td><a name="l69" href="#l69">69</a><td>ServiceBuilder.prototype.port_ = 0;<tr><td><a name="l70" href="#l70">70</a><td><tr><td><a name="l71" href="#l71">71</a><td><tr><td><a name="l72" href="#l72">72</a><td>/** @private {(string|!Array.<string|number|!Stream|null|undefined>)} */<tr><td><a name="l73" href="#l73">73</a><td>ServiceBuilder.prototype.stdio_ = 'ignore';<tr><td><a name="l74" href="#l74">74</a><td><tr><td><a name="l75" href="#l75">75</a><td><tr><td><a name="l76" href="#l76">76</a><td>/** @private {Object.<string, string>} */<tr><td><a name="l77" href="#l77">77</a><td>ServiceBuilder.prototype.env_ = null;<tr><td><a name="l78" href="#l78">78</a><td><tr><td><a name="l79" href="#l79">79</a><td><tr><td><a name="l80" href="#l80">80</a><td>/**<tr><td><a name="l81" href="#l81">81</a><td> * Sets the port to start the ChromeDriver on.<tr><td><a name="l82" href="#l82">82</a><td> * @param {number} port The port to use, or 0 for any free port.<tr><td><a name="l83" href="#l83">83</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l84" href="#l84">84</a><td> * @throws {Error} If the port is invalid.<tr><td><a name="l85" href="#l85">85</a><td> */<tr><td><a name="l86" href="#l86">86</a><td>ServiceBuilder.prototype.usingPort = function(port) {<tr><td><a name="l87" href="#l87">87</a><td> if (port < 0) {<tr><td><a name="l88" href="#l88">88</a><td> throw Error('port must be >= 0: ' + port);<tr><td><a name="l89" href="#l89">89</a><td> }<tr><td><a name="l90" href="#l90">90</a><td> this.port_ = port;<tr><td><a name="l91" href="#l91">91</a><td> return this;<tr><td><a name="l92" href="#l92">92</a><td>};<tr><td><a name="l93" href="#l93">93</a><td><tr><td><a name="l94" href="#l94">94</a><td><tr><td><a name="l95" href="#l95">95</a><td>/**<tr><td><a name="l96" href="#l96">96</a><td> * Sets the path of the log file the driver should log to. If a log file is<tr><td><a name="l97" href="#l97">97</a><td> * not specified, the driver will log to stderr.<tr><td><a name="l98" href="#l98">98</a><td> * @param {string} path Path of the log file to use.<tr><td><a name="l99" href="#l99">99</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l100" href="#l100">100</a><td> */<tr><td><a name="l101" href="#l101">101</a><td>ServiceBuilder.prototype.loggingTo = function(path) {<tr><td><a name="l102" href="#l102">102</a><td> this.args_.push('--log-path=' + path);<tr><td><a name="l103" href="#l103">103</a><td> return this;<tr><td><a name="l104" href="#l104">104</a><td>};<tr><td><a name="l105" href="#l105">105</a><td><tr><td><a name="l106" href="#l106">106</a><td><tr><td><a name="l107" href="#l107">107</a><td>/**<tr><td><a name="l108" href="#l108">108</a><td> * Enables verbose logging.<tr><td><a name="l109" href="#l109">109</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l110" href="#l110">110</a><td> */<tr><td><a name="l111" href="#l111">111</a><td>ServiceBuilder.prototype.enableVerboseLogging = function() {<tr><td><a name="l112" href="#l112">112</a><td> this.args_.push('--verbose');<tr><td><a name="l113" href="#l113">113</a><td> return this;<tr><td><a name="l114" href="#l114">114</a><td>};<tr><td><a name="l115" href="#l115">115</a><td><tr><td><a name="l116" href="#l116">116</a><td><tr><td><a name="l117" href="#l117">117</a><td>/**<tr><td><a name="l118" href="#l118">118</a><td> * Sets the number of threads the driver should use to manage HTTP requests.<tr><td><a name="l119" href="#l119">119</a><td> * By default, the driver will use 4 threads.<tr><td><a name="l120" href="#l120">120</a><td> * @param {number} n The number of threads to use.<tr><td><a name="l121" href="#l121">121</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l122" href="#l122">122</a><td> */<tr><td><a name="l123" href="#l123">123</a><td>ServiceBuilder.prototype.setNumHttpThreads = function(n) {<tr><td><a name="l124" href="#l124">124</a><td> this.args_.push('--http-threads=' + n);<tr><td><a name="l125" href="#l125">125</a><td> return this;<tr><td><a name="l126" href="#l126">126</a><td>};<tr><td><a name="l127" href="#l127">127</a><td><tr><td><a name="l128" href="#l128">128</a><td><tr><td><a name="l129" href="#l129">129</a><td>/**<tr><td><a name="l130" href="#l130">130</a><td> * Sets the base path for WebDriver REST commands (e.g. "/wd/hub").<tr><td><a name="l131" href="#l131">131</a><td> * By default, the driver will accept commands relative to "/".<tr><td><a name="l132" href="#l132">132</a><td> * @param {string} path The base path to use.<tr><td><a name="l133" href="#l133">133</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l134" href="#l134">134</a><td> */<tr><td><a name="l135" href="#l135">135</a><td>ServiceBuilder.prototype.setUrlBasePath = function(path) {<tr><td><a name="l136" href="#l136">136</a><td> this.args_.push('--url-base=' + path);<tr><td><a name="l137" href="#l137">137</a><td> return this;<tr><td><a name="l138" href="#l138">138</a><td>};<tr><td><a name="l139" href="#l139">139</a><td><tr><td><a name="l140" href="#l140">140</a><td><tr><td><a name="l141" href="#l141">141</a><td>/**<tr><td><a name="l142" href="#l142">142</a><td> * Defines the stdio configuration for the driver service. See<tr><td><a name="l143" href="#l143">143</a><td> * {@code child_process.spawn} for more information.<tr><td><a name="l144" href="#l144">144</a><td> * @param {(string|!Array.<string|number|!Stream|null|undefined>)} config The<tr><td><a name="l145" href="#l145">145</a><td> * configuration to use.<tr><td><a name="l146" href="#l146">146</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l147" href="#l147">147</a><td> */<tr><td><a name="l148" href="#l148">148</a><td>ServiceBuilder.prototype.setStdio = function(config) {<tr><td><a name="l149" href="#l149">149</a><td> this.stdio_ = config;<tr><td><a name="l150" href="#l150">150</a><td> return this;<tr><td><a name="l151" href="#l151">151</a><td>};<tr><td><a name="l152" href="#l152">152</a><td><tr><td><a name="l153" href="#l153">153</a><td><tr><td><a name="l154" href="#l154">154</a><td>/**<tr><td><a name="l155" href="#l155">155</a><td> * Defines the environment to start the server under. This settings will be<tr><td><a name="l156" href="#l156">156</a><td> * inherited by every browser session started by the server.<tr><td><a name="l157" href="#l157">157</a><td> * @param {!Object.<string, string>} env The environment to use.<tr><td><a name="l158" href="#l158">158</a><td> * @return {!ServiceBuilder} A self reference.<tr><td><a name="l159" href="#l159">159</a><td> */<tr><td><a name="l160" href="#l160">160</a><td>ServiceBuilder.prototype.withEnvironment = function(env) {<tr><td><a name="l161" href="#l161">161</a><td> this.env_ = env;<tr><td><a name="l162" href="#l162">162</a><td> return this;<tr><td><a name="l163" href="#l163">163</a><td>};<tr><td><a name="l164" href="#l164">164</a><td><tr><td><a name="l165" href="#l165">165</a><td><tr><td><a name="l166" href="#l166">166</a><td>/**<tr><td><a name="l167" href="#l167">167</a><td> * Creates a new DriverService using this instance's current configuration.<tr><td><a name="l168" href="#l168">168</a><td> * @return {remote.DriverService} A new driver service using this instance's<tr><td><a name="l169" href="#l169">169</a><td> * current configuration.<tr><td><a name="l170" href="#l170">170</a><td> * @throws {Error} If the driver exectuable was not specified and a default<tr><td><a name="l171" href="#l171">171</a><td> * could not be found on the current PATH.<tr><td><a name="l172" href="#l172">172</a><td> */<tr><td><a name="l173" href="#l173">173</a><td>ServiceBuilder.prototype.build = function() {<tr><td><a name="l174" href="#l174">174</a><td> var port = this.port_ || portprober.findFreePort();<tr><td><a name="l175" href="#l175">175</a><td> var args = this.args_.concat(); // Defensive copy.<tr><td><a name="l176" href="#l176">176</a><td><tr><td><a name="l177" href="#l177">177</a><td> return new remote.DriverService(this.exe_, {<tr><td><a name="l178" href="#l178">178</a><td> port: port,<tr><td><a name="l179" href="#l179">179</a><td> args: webdriver.promise.when(port, function(port) {<tr><td><a name="l180" href="#l180">180</a><td> return args.concat('--port=' + port);<tr><td><a name="l181" href="#l181">181</a><td> }),<tr><td><a name="l182" href="#l182">182</a><td> env: this.env_,<tr><td><a name="l183" href="#l183">183</a><td> stdio: this.stdio_<tr><td><a name="l184" href="#l184">184</a><td> });<tr><td><a name="l185" href="#l185">185</a><td>};<tr><td><a name="l186" href="#l186">186</a><td><tr><td><a name="l187" href="#l187">187</a><td><tr><td><a name="l188" href="#l188">188</a><td>/** @type {remote.DriverService} */<tr><td><a name="l189" href="#l189">189</a><td>var defaultService = null;<tr><td><a name="l190" href="#l190">190</a><td><tr><td><a name="l191" href="#l191">191</a><td><tr><td><a name="l192" href="#l192">192</a><td>/**<tr><td><a name="l193" href="#l193">193</a><td> * Sets the default service to use for new ChromeDriver instances.<tr><td><a name="l194" href="#l194">194</a><td> * @param {!remote.DriverService} service The service to use.<tr><td><a name="l195" href="#l195">195</a><td> * @throws {Error} If the default service is currently running.<tr><td><a name="l196" href="#l196">196</a><td> */<tr><td><a name="l197" href="#l197">197</a><td>function setDefaultService(service) {<tr><td><a name="l198" href="#l198">198</a><td> if (defaultService && defaultService.isRunning()) {<tr><td><a name="l199" href="#l199">199</a><td> throw Error(<tr><td><a name="l200" href="#l200">200</a><td> 'The previously configured ChromeDriver service is still running. ' +<tr><td><a name="l201" href="#l201">201</a><td> 'You must shut it down before you may adjust its configuration.');<tr><td><a name="l202" href="#l202">202</a><td> }<tr><td><a name="l203" href="#l203">203</a><td> defaultService = service;<tr><td><a name="l204" href="#l204">204</a><td>}<tr><td><a name="l205" href="#l205">205</a><td><tr><td><a name="l206" href="#l206">206</a><td><tr><td><a name="l207" href="#l207">207</a><td>/**<tr><td><a name="l208" href="#l208">208</a><td> * Returns the default ChromeDriver service. If such a service has not been<tr><td><a name="l209" href="#l209">209</a><td> * configured, one will be constructed using the default configuration for<tr><td><a name="l210" href="#l210">210</a><td> * a ChromeDriver executable found on the system PATH.<tr><td><a name="l211" href="#l211">211</a><td> * @return {!remote.DriverService} The default ChromeDriver service.<tr><td><a name="l212" href="#l212">212</a><td> */<tr><td><a name="l213" href="#l213">213</a><td>function getDefaultService() {<tr><td><a name="l214" href="#l214">214</a><td> if (!defaultService) {<tr><td><a name="l215" href="#l215">215</a><td> defaultService = new ServiceBuilder().build();<tr><td><a name="l216" href="#l216">216</a><td> }<tr><td><a name="l217" href="#l217">217</a><td> return defaultService;<tr><td><a name="l218" href="#l218">218</a><td>}<tr><td><a name="l219" href="#l219">219</a><td><tr><td><a name="l220" href="#l220">220</a><td><tr><td><a name="l221" href="#l221">221</a><td>/**<tr><td><a name="l222" href="#l222">222</a><td> * @type {string}<tr><td><a name="l223" href="#l223">223</a><td> * @const<tr><td><a name="l224" href="#l224">224</a><td> */<tr><td><a name="l225" href="#l225">225</a><td>var OPTIONS_CAPABILITY_KEY = 'chromeOptions';<tr><td><a name="l226" href="#l226">226</a><td><tr><td><a name="l227" href="#l227">227</a><td><tr><td><a name="l228" href="#l228">228</a><td>/**<tr><td><a name="l229" href="#l229">229</a><td> * Class for managing ChromeDriver specific options.<tr><td><a name="l230" href="#l230">230</a><td> * @constructor<tr><td><a name="l231" href="#l231">231</a><td> */<tr><td><a name="l232" href="#l232">232</a><td>var Options = function() {<tr><td><a name="l233" href="#l233">233</a><td> /** @private {!Array.<string>} */<tr><td><a name="l234" href="#l234">234</a><td> this.args_ = [];<tr><td><a name="l235" href="#l235">235</a><td><tr><td><a name="l236" href="#l236">236</a><td> /** @private {!Array.<(string|!Buffer)>} */<tr><td><a name="l237" href="#l237">237</a><td> this.extensions_ = [];<tr><td><a name="l238" href="#l238">238</a><td>};<tr><td><a name="l239" href="#l239">239</a><td><tr><td><a name="l240" href="#l240">240</a><td><tr><td><a name="l241" href="#l241">241</a><td>/**<tr><td><a name="l242" href="#l242">242</a><td> * Extracts the ChromeDriver specific options from the given capabilities<tr><td><a name="l243" href="#l243">243</a><td> * object.<tr><td><a name="l244" href="#l244">244</a><td> * @param {!webdriver.Capabilities} capabilities The capabilities object.<tr><td><a name="l245" href="#l245">245</a><td> * @return {!Options} The ChromeDriver options.<tr><td><a name="l246" href="#l246">246</a><td> */<tr><td><a name="l247" href="#l247">247</a><td>Options.fromCapabilities = function(capabilities) {<tr><td><a name="l248" href="#l248">248</a><td> var options = new Options();<tr><td><a name="l249" href="#l249">249</a><td><tr><td><a name="l250" href="#l250">250</a><td> var o = capabilities.get(OPTIONS_CAPABILITY_KEY);<tr><td><a name="l251" href="#l251">251</a><td> if (o instanceof Options) {<tr><td><a name="l252" href="#l252">252</a><td> options = o;<tr><td><a name="l253" href="#l253">253</a><td> } else if (o) {<tr><td><a name="l254" href="#l254">254</a><td> options.<tr><td><a name="l255" href="#l255">255</a><td> addArguments(o.args || []).<tr><td><a name="l256" href="#l256">256</a><td> addExtensions(o.extensions || []).<tr><td><a name="l257" href="#l257">257</a><td> detachDriver(!!o.detach).<tr><td><a name="l258" href="#l258">258</a><td> setChromeBinaryPath(o.binary).<tr><td><a name="l259" href="#l259">259</a><td> setChromeLogFile(o.logFile).<tr><td><a name="l260" href="#l260">260</a><td> setLocalState(o.localState).<tr><td><a name="l261" href="#l261">261</a><td> setUserPreferences(o.prefs);<tr><td><a name="l262" href="#l262">262</a><td> }<tr><td><a name="l263" href="#l263">263</a><td><tr><td><a name="l264" href="#l264">264</a><td> if (capabilities.has(webdriver.Capability.PROXY)) {<tr><td><a name="l265" href="#l265">265</a><td> options.setProxy(capabilities.get(webdriver.Capability.PROXY));<tr><td><a name="l266" href="#l266">266</a><td> }<tr><td><a name="l267" href="#l267">267</a><td><tr><td><a name="l268" href="#l268">268</a><td> if (capabilities.has(webdriver.Capability.LOGGING_PREFS)) {<tr><td><a name="l269" href="#l269">269</a><td> options.setLoggingPreferences(<tr><td><a name="l270" href="#l270">270</a><td> capabilities.get(webdriver.Capability.LOGGING_PREFS));<tr><td><a name="l271" href="#l271">271</a><td> }<tr><td><a name="l272" href="#l272">272</a><td><tr><td><a name="l273" href="#l273">273</a><td> return options;<tr><td><a name="l274" href="#l274">274</a><td>};<tr><td><a name="l275" href="#l275">275</a><td><tr><td><a name="l276" href="#l276">276</a><td><tr><td><a name="l277" href="#l277">277</a><td>/**<tr><td><a name="l278" href="#l278">278</a><td> * Add additional command line arguments to use when launching the Chrome<tr><td><a name="l279" href="#l279">279</a><td> * browser. Each argument may be specified with or without the "--" prefix<tr><td><a name="l280" href="#l280">280</a><td> * (e.g. "--foo" and "foo"). Arguments with an associated value should be<tr><td><a name="l281" href="#l281">281</a><td> * delimited by an "=": "foo=bar".<tr><td><a name="l282" href="#l282">282</a><td> * @param {...(string|!Array.<string>)} var_args The arguments to add.<tr><td><a name="l283" href="#l283">283</a><td> * @return {!Options} A self reference.<tr><td><a name="l284" href="#l284">284</a><td> */<tr><td><a name="l285" href="#l285">285</a><td>Options.prototype.addArguments = function(var_args) {<tr><td><a name="l286" href="#l286">286</a><td> this.args_ = this.args_.concat.apply(this.args_, arguments);<tr><td><a name="l287" href="#l287">287</a><td> return this;<tr><td><a name="l288" href="#l288">288</a><td>};<tr><td><a name="l289" href="#l289">289</a><td><tr><td><a name="l290" href="#l290">290</a><td><tr><td><a name="l291" href="#l291">291</a><td>/**<tr><td><a name="l292" href="#l292">292</a><td> * Add additional extensions to install when launching Chrome. Each extension<tr><td><a name="l293" href="#l293">293</a><td> * should be specified as the path to the packed CRX file, or a Buffer for an<tr><td><a name="l294" href="#l294">294</a><td> * extension.<tr><td><a name="l295" href="#l295">295</a><td> * @param {...(string|!Buffer|!Array.<(string|!Buffer)>)} var_args The<tr><td><a name="l296" href="#l296">296</a><td> * extensions to add.<tr><td><a name="l297" href="#l297">297</a><td> * @return {!Options} A self reference.<tr><td><a name="l298" href="#l298">298</a><td> */<tr><td><a name="l299" href="#l299">299</a><td>Options.prototype.addExtensions = function(var_args) {<tr><td><a name="l300" href="#l300">300</a><td> this.extensions_ = this.extensions_.concat.apply(<tr><td><a name="l301" href="#l301">301</a><td> this.extensions_, arguments);<tr><td><a name="l302" href="#l302">302</a><td> return this;<tr><td><a name="l303" href="#l303">303</a><td>};<tr><td><a name="l304" href="#l304">304</a><td><tr><td><a name="l305" href="#l305">305</a><td><tr><td><a name="l306" href="#l306">306</a><td>/**<tr><td><a name="l307" href="#l307">307</a><td> * Sets the path to the Chrome binary to use. On Mac OS X, this path should<tr><td><a name="l308" href="#l308">308</a><td> * reference the actual Chrome executable, not just the application binary<tr><td><a name="l309" href="#l309">309</a><td> * (e.g. "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome").<tr><td><a name="l310" href="#l310">310</a><td> *<tr><td><a name="l311" href="#l311">311</a><td> * The binary path be absolute or relative to the chromedriver server<tr><td><a name="l312" href="#l312">312</a><td> * executable, but it must exist on the machine that will launch Chrome.<tr><td><a name="l313" href="#l313">313</a><td> *<tr><td><a name="l314" href="#l314">314</a><td> * @param {string} path The path to the Chrome binary to use.<tr><td><a name="l315" href="#l315">315</a><td> * @return {!Options} A self reference.<tr><td><a name="l316" href="#l316">316</a><td> */<tr><td><a name="l317" href="#l317">317</a><td>Options.prototype.setChromeBinaryPath = function(path) {<tr><td><a name="l318" href="#l318">318</a><td> this.binary_ = path;<tr><td><a name="l319" href="#l319">319</a><td> return this;<tr><td><a name="l320" href="#l320">320</a><td>};<tr><td><a name="l321" href="#l321">321</a><td><tr><td><a name="l322" href="#l322">322</a><td><tr><td><a name="l323" href="#l323">323</a><td>/**<tr><td><a name="l324" href="#l324">324</a><td> * Sets whether to leave the started Chrome browser running if the controlling<tr><td><a name="l325" href="#l325">325</a><td> * ChromeDriver service is killed before {@link webdriver.WebDriver#quit()} is<tr><td><a name="l326" href="#l326">326</a><td> * called.<tr><td><a name="l327" href="#l327">327</a><td> * @param {boolean} detach Whether to leave the browser running if the<tr><td><a name="l328" href="#l328">328</a><td> * chromedriver service is killed before the session.<tr><td><a name="l329" href="#l329">329</a><td> * @return {!Options} A self reference.<tr><td><a name="l330" href="#l330">330</a><td> */<tr><td><a name="l331" href="#l331">331</a><td>Options.prototype.detachDriver = function(detach) {<tr><td><a name="l332" href="#l332">332</a><td> this.detach_ = detach;<tr><td><a name="l333" href="#l333">333</a><td> return this;<tr><td><a name="l334" href="#l334">334</a><td>};<tr><td><a name="l335" href="#l335">335</a><td><tr><td><a name="l336" href="#l336">336</a><td><tr><td><a name="l337" href="#l337">337</a><td>/**<tr><td><a name="l338" href="#l338">338</a><td> * Sets the user preferences for Chrome's user profile. See the "Preferences"<tr><td><a name="l339" href="#l339">339</a><td> * file in Chrome's user data directory for examples.<tr><td><a name="l340" href="#l340">340</a><td> * @param {!Object} prefs Dictionary of user preferences to use.<tr><td><a name="l341" href="#l341">341</a><td> * @return {!Options} A self reference.<tr><td><a name="l342" href="#l342">342</a><td> */<tr><td><a name="l343" href="#l343">343</a><td>Options.prototype.setUserPreferences = function(prefs) {<tr><td><a name="l344" href="#l344">344</a><td> this.prefs_ = prefs;<tr><td><a name="l345" href="#l345">345</a><td> return this;<tr><td><a name="l346" href="#l346">346</a><td>};<tr><td><a name="l347" href="#l347">347</a><td><tr><td><a name="l348" href="#l348">348</a><td><tr><td><a name="l349" href="#l349">349</a><td>/**<tr><td><a name="l350" href="#l350">350</a><td> * Sets the logging preferences for the new session.<tr><td><a name="l351" href="#l351">351</a><td> * @param {!webdriver.logging.Preferences} prefs The logging preferences.<tr><td><a name="l352" href="#l352">352</a><td> * @return {!Options} A self reference.<tr><td><a name="l353" href="#l353">353</a><td> */<tr><td><a name="l354" href="#l354">354</a><td>Options.prototype.setLoggingPreferences = function(prefs) {<tr><td><a name="l355" href="#l355">355</a><td> this.logPrefs_ = prefs;<tr><td><a name="l356" href="#l356">356</a><td> return this;<tr><td><a name="l357" href="#l357">357</a><td>};<tr><td><a name="l358" href="#l358">358</a><td><tr><td><a name="l359" href="#l359">359</a><td><tr><td><a name="l360" href="#l360">360</a><td>/**<tr><td><a name="l361" href="#l361">361</a><td> * Sets preferences for the "Local State" file in Chrome's user data<tr><td><a name="l362" href="#l362">362</a><td> * directory.<tr><td><a name="l363" href="#l363">363</a><td> * @param {!Object} state Dictionary of local state preferences.<tr><td><a name="l364" href="#l364">364</a><td> * @return {!Options} A self reference.<tr><td><a name="l365" href="#l365">365</a><td> */<tr><td><a name="l366" href="#l366">366</a><td>Options.prototype.setLocalState = function(state) {<tr><td><a name="l367" href="#l367">367</a><td> this.localState_ = state;<tr><td><a name="l368" href="#l368">368</a><td> return this;<tr><td><a name="l369" href="#l369">369</a><td>};<tr><td><a name="l370" href="#l370">370</a><td><tr><td><a name="l371" href="#l371">371</a><td><tr><td><a name="l372" href="#l372">372</a><td>/**<tr><td><a name="l373" href="#l373">373</a><td> * Sets the path to Chrome's log file. This path should exist on the machine<tr><td><a name="l374" href="#l374">374</a><td> * that will launch Chrome.<tr><td><a name="l375" href="#l375">375</a><td> * @param {string} path Path to the log file to use.<tr><td><a name="l376" href="#l376">376</a><td> * @return {!Options} A self reference.<tr><td><a name="l377" href="#l377">377</a><td> */<tr><td><a name="l378" href="#l378">378</a><td>Options.prototype.setChromeLogFile = function(path) {<tr><td><a name="l379" href="#l379">379</a><td> this.logFile_ = path;<tr><td><a name="l380" href="#l380">380</a><td> return this;<tr><td><a name="l381" href="#l381">381</a><td>};<tr><td><a name="l382" href="#l382">382</a><td><tr><td><a name="l383" href="#l383">383</a><td><tr><td><a name="l384" href="#l384">384</a><td>/**<tr><td><a name="l385" href="#l385">385</a><td> * Sets the proxy settings for the new session.<tr><td><a name="l386" href="#l386">386</a><td> * @param {ProxyConfig} proxy The proxy configuration to use.<tr><td><a name="l387" href="#l387">387</a><td> * @return {!Options} A self reference.<tr><td><a name="l388" href="#l388">388</a><td> */<tr><td><a name="l389" href="#l389">389</a><td>Options.prototype.setProxy = function(proxy) {<tr><td><a name="l390" href="#l390">390</a><td> this.proxy_ = proxy;<tr><td><a name="l391" href="#l391">391</a><td> return this;<tr><td><a name="l392" href="#l392">392</a><td>};<tr><td><a name="l393" href="#l393">393</a><td><tr><td><a name="l394" href="#l394">394</a><td><tr><td><a name="l395" href="#l395">395</a><td>/**<tr><td><a name="l396" href="#l396">396</a><td> * Converts this options instance to a {@link webdriver.Capabilities} object.<tr><td><a name="l397" href="#l397">397</a><td> * @param {webdriver.Capabilities=} opt_capabilities The capabilities to merge<tr><td><a name="l398" href="#l398">398</a><td> * these options into, if any.<tr><td><a name="l399" href="#l399">399</a><td> * @return {!webdriver.Capabilities} The capabilities.<tr><td><a name="l400" href="#l400">400</a><td> */<tr><td><a name="l401" href="#l401">401</a><td>Options.prototype.toCapabilities = function(opt_capabilities) {<tr><td><a name="l402" href="#l402">402</a><td> var capabilities = opt_capabilities || webdriver.Capabilities.chrome();<tr><td><a name="l403" href="#l403">403</a><td> capabilities.<tr><td><a name="l404" href="#l404">404</a><td> set(webdriver.Capability.PROXY, this.proxy_).<tr><td><a name="l405" href="#l405">405</a><td> set(webdriver.Capability.LOGGING_PREFS, this.logPrefs_).<tr><td><a name="l406" href="#l406">406</a><td> set(OPTIONS_CAPABILITY_KEY, this);<tr><td><a name="l407" href="#l407">407</a><td> return capabilities;<tr><td><a name="l408" href="#l408">408</a><td>};<tr><td><a name="l409" href="#l409">409</a><td><tr><td><a name="l410" href="#l410">410</a><td><tr><td><a name="l411" href="#l411">411</a><td>/**<tr><td><a name="l412" href="#l412">412</a><td> * Converts this instance to its JSON wire protocol representation. Note this<tr><td><a name="l413" href="#l413">413</a><td> * function is an implementation not intended for general use.<tr><td><a name="l414" href="#l414">414</a><td> * @return {{args: !Array.<string>,<tr><td><a name="l415" href="#l415">415</a><td> * binary: (string|undefined),<tr><td><a name="l416" href="#l416">416</a><td> * detach: boolean,<tr><td><a name="l417" href="#l417">417</a><td> * extensions: !Array.<string>,<tr><td><a name="l418" href="#l418">418</a><td> * localState: (Object|undefined),<tr><td><a name="l419" href="#l419">419</a><td> * logFile: (string|undefined),<tr><td><a name="l420" href="#l420">420</a><td> * prefs: (Object|undefined)}} The JSON wire protocol representation<tr><td><a name="l421" href="#l421">421</a><td> * of this instance.<tr><td><a name="l422" href="#l422">422</a><td> */<tr><td><a name="l423" href="#l423">423</a><td>Options.prototype.toJSON = function() {<tr><td><a name="l424" href="#l424">424</a><td> return {<tr><td><a name="l425" href="#l425">425</a><td> args: this.args_,<tr><td><a name="l426" href="#l426">426</a><td> binary: this.binary_,<tr><td><a name="l427" href="#l427">427</a><td> detach: !!this.detach_,<tr><td><a name="l428" href="#l428">428</a><td> extensions: this.extensions_.map(function(extension) {<tr><td><a name="l429" href="#l429">429</a><td> if (Buffer.isBuffer(extension)) {<tr><td><a name="l430" href="#l430">430</a><td> return extension.toString('base64');<tr><td><a name="l431" href="#l431">431</a><td> }<tr><td><a name="l432" href="#l432">432</a><td> return fs.readFileSync(extension, 'base64');<tr><td><a name="l433" href="#l433">433</a><td> }),<tr><td><a name="l434" href="#l434">434</a><td> localState: this.localState_,<tr><td><a name="l435" href="#l435">435</a><td> logFile: this.logFile_,<tr><td><a name="l436" href="#l436">436</a><td> prefs: this.prefs_<tr><td><a name="l437" href="#l437">437</a><td> };<tr><td><a name="l438" href="#l438">438</a><td>};<tr><td><a name="l439" href="#l439">439</a><td><tr><td><a name="l440" href="#l440">440</a><td><tr><td><a name="l441" href="#l441">441</a><td>/**<tr><td><a name="l442" href="#l442">442</a><td> * Creates a new ChromeDriver session.<tr><td><a name="l443" href="#l443">443</a><td> * @param {(webdriver.Capabilities|Options)=} opt_options The session options.<tr><td><a name="l444" href="#l444">444</a><td> * @param {remote.DriverService=} opt_service The session to use; will use<tr><td><a name="l445" href="#l445">445</a><td> * the {@link getDefaultService default service} by default.<tr><td><a name="l446" href="#l446">446</a><td> * @return {!webdriver.WebDriver} A new WebDriver instance.<tr><td><a name="l447" href="#l447">447</a><td> */<tr><td><a name="l448" href="#l448">448</a><td>function createDriver(opt_options, opt_service) {<tr><td><a name="l449" href="#l449">449</a><td> var service = opt_service || getDefaultService();<tr><td><a name="l450" href="#l450">450</a><td> var executor = executors.createExecutor(service.start());<tr><td><a name="l451" href="#l451">451</a><td><tr><td><a name="l452" href="#l452">452</a><td> var options = opt_options || new Options();<tr><td><a name="l453" href="#l453">453</a><td> if (opt_options instanceof webdriver.Capabilities) {<tr><td><a name="l454" href="#l454">454</a><td> // Extract the Chrome-specific options so we do not send unnecessary<tr><td><a name="l455" href="#l455">455</a><td> // data across the wire.<tr><td><a name="l456" href="#l456">456</a><td> options = Options.fromCapabilities(options);<tr><td><a name="l457" href="#l457">457</a><td> }<tr><td><a name="l458" href="#l458">458</a><td><tr><td><a name="l459" href="#l459">459</a><td> return webdriver.WebDriver.createSession(<tr><td><a name="l460" href="#l460">460</a><td> executor, options.toCapabilities());<tr><td><a name="l461" href="#l461">461</a><td>}<tr><td><a name="l462" href="#l462">462</a><td><tr><td><a name="l463" href="#l463">463</a><td><tr><td><a name="l464" href="#l464">464</a><td><tr><td><a name="l465" href="#l465">465</a><td>// PUBLIC API<tr><td><a name="l466" href="#l466">466</a><td><tr><td><a name="l467" href="#l467">467</a><td><tr><td><a name="l468" href="#l468">468</a><td>exports.ServiceBuilder = ServiceBuilder;<tr><td><a name="l469" href="#l469">469</a><td>exports.Options = Options;<tr><td><a name="l470" href="#l470">470</a><td>exports.createDriver = createDriver;<tr><td><a name="l471" href="#l471">471</a><td>exports.getDefaultService = getDefaultService;<tr><td><a name="l472" href="#l472">472</a><td>exports.setDefaultService = setDefaultService;</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>No data</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>No data</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>No data</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../types.js"></script><script src="../dossier.js"></script>
You can’t perform that action at this time.