selenium-webdriver 2.43.5 → 2.44.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (219) hide show
  1. package/CHANGES.md +20 -0
  2. package/README.md +8 -13
  3. package/builder.js +4 -3
  4. package/docs/class_webdriver_Alert.html +6 -6
  5. package/docs/class_webdriver_AlertPromise.html +6 -6
  6. package/docs/class_webdriver_UnhandledAlertError.html +4 -4
  7. package/docs/class_webdriver_WebDriver.html +39 -37
  8. package/docs/class_webdriver_WebDriver_Logs.html +3 -3
  9. package/docs/class_webdriver_WebDriver_Navigation.html +5 -5
  10. package/docs/class_webdriver_WebDriver_Options.html +9 -9
  11. package/docs/class_webdriver_WebDriver_TargetLocator.html +6 -6
  12. package/docs/class_webdriver_WebDriver_Timeouts.html +4 -4
  13. package/docs/class_webdriver_WebDriver_Window.html +6 -6
  14. package/docs/class_webdriver_WebElement.html +23 -23
  15. package/docs/class_webdriver_WebElementPromise.html +22 -22
  16. package/docs/class_webdriver_promise_CancellationError.html +3 -0
  17. package/docs/class_webdriver_promise_ControlFlow.html +32 -32
  18. package/docs/class_webdriver_promise_Deferred.html +7 -8
  19. package/docs/class_webdriver_promise_Frame_.html +14 -30
  20. package/docs/class_webdriver_promise_Promise.html +2 -2
  21. package/docs/class_webdriver_promise_Task_.html +12 -12
  22. package/docs/class_webdriver_until_Condition.html +3 -0
  23. package/docs/enum_webdriver_Key.html +1 -1
  24. package/docs/enum_webdriver_promise_ControlFlow_EventType.html +1 -1
  25. package/docs/enum_webdriver_promise_Deferred_State_.html +1 -1
  26. package/docs/index.html +8 -13
  27. package/docs/interface_webdriver_promise_Thenable.html +8 -10
  28. package/docs/license.html +1 -1
  29. package/docs/module_selenium-webdriver.html +2 -2
  30. package/docs/module_selenium-webdriver__base.html +1 -1
  31. package/docs/module_selenium-webdriver__base_class_Context.html +1 -1
  32. package/docs/module_selenium-webdriver_builder.html +1 -1
  33. package/docs/module_selenium-webdriver_builder_class_Builder.html +1 -1
  34. package/docs/module_selenium-webdriver_chrome.html +1 -1
  35. package/docs/module_selenium-webdriver_chrome_class_Driver.html +2 -2
  36. package/docs/module_selenium-webdriver_chrome_class_Options.html +2 -2
  37. package/docs/module_selenium-webdriver_chrome_class_ServiceBuilder.html +1 -1
  38. package/docs/module_selenium-webdriver_error.html +1 -1
  39. package/docs/module_selenium-webdriver_executors.html +1 -1
  40. package/docs/module_selenium-webdriver_firefox.html +1 -1
  41. package/docs/module_selenium-webdriver_firefox_binary.html +1 -1
  42. package/docs/module_selenium-webdriver_firefox_binary_class_Binary.html +1 -1
  43. package/docs/module_selenium-webdriver_firefox_class_Driver.html +2 -2
  44. package/docs/module_selenium-webdriver_firefox_class_Options.html +1 -1
  45. package/docs/module_selenium-webdriver_firefox_extension.html +1 -1
  46. package/docs/module_selenium-webdriver_firefox_profile.html +1 -1
  47. package/docs/module_selenium-webdriver_firefox_profile_class_Profile.html +1 -1
  48. package/docs/module_selenium-webdriver_http.html +1 -1
  49. package/docs/module_selenium-webdriver_http_class_HttpClient.html +1 -1
  50. package/docs/module_selenium-webdriver_http_util.html +1 -1
  51. package/docs/module_selenium-webdriver_io.html +1 -1
  52. package/docs/module_selenium-webdriver_io_exec.html +1 -1
  53. package/docs/module_selenium-webdriver_net.html +1 -1
  54. package/docs/module_selenium-webdriver_net_portprober.html +1 -1
  55. package/docs/module_selenium-webdriver_phantomjs.html +1 -1
  56. package/docs/module_selenium-webdriver_phantomjs_class_Driver.html +2 -2
  57. package/docs/module_selenium-webdriver_proxy.html +1 -1
  58. package/docs/module_selenium-webdriver_remote.html +1 -1
  59. package/docs/module_selenium-webdriver_remote_class_DriverService.html +2 -2
  60. package/docs/module_selenium-webdriver_remote_class_SeleniumServer.html +2 -2
  61. package/docs/module_selenium-webdriver_testing.html +16 -29
  62. package/docs/module_selenium-webdriver_testing_assert.html +1 -1
  63. package/docs/namespace_webdriver_promise.html +18 -20
  64. package/docs/namespace_webdriver_stacktrace.html +15 -15
  65. package/docs/namespace_webdriver_until.html +32 -0
  66. package/docs/source/_base.js.src.html +1 -1
  67. package/docs/source/builder.js.src.html +1 -1
  68. package/docs/source/chrome.js.src.html +1 -1
  69. package/docs/source/error.js.src.html +1 -1
  70. package/docs/source/executors.js.src.html +1 -1
  71. package/docs/source/firefox/binary.js.src.html +1 -1
  72. package/docs/source/firefox/extension.js.src.html +1 -1
  73. package/docs/source/firefox/index.js.src.html +1 -1
  74. package/docs/source/firefox/profile.js.src.html +1 -1
  75. package/docs/source/http/index.js.src.html +1 -1
  76. package/docs/source/http/util.js.src.html +1 -1
  77. package/docs/source/index.js.src.html +1 -1
  78. package/docs/source/io/exec.js.src.html +1 -1
  79. package/docs/source/io/index.js.src.html +1 -1
  80. package/docs/source/lib/atoms/error.js.src.html +1 -1
  81. package/docs/source/lib/atoms/json.js.src.html +1 -1
  82. package/docs/source/lib/atoms/response.js.src.html +1 -1
  83. package/docs/source/lib/atoms/userAgent.js.src.html +1 -1
  84. package/docs/source/lib/goog/array/array.js.src.html +1 -1
  85. package/docs/source/lib/goog/asserts/asserts.js.src.html +1 -1
  86. package/docs/source/lib/goog/async/nexttick.js.src.html +1 -1
  87. package/docs/source/lib/goog/async/run.js.src.html +1 -1
  88. package/docs/source/lib/goog/base.js.src.html +1 -1
  89. package/docs/source/lib/goog/debug/debug.js.src.html +1 -1
  90. package/docs/source/lib/goog/debug/entrypointregistry.js.src.html +1 -1
  91. package/docs/source/lib/goog/debug/error.js.src.html +1 -1
  92. package/docs/source/lib/goog/debug/logbuffer.js.src.html +1 -1
  93. package/docs/source/lib/goog/debug/logger.js.src.html +1 -1
  94. package/docs/source/lib/goog/debug/logrecord.js.src.html +1 -1
  95. package/docs/source/lib/goog/deps.js.src.html +1 -1
  96. package/docs/source/lib/goog/disposable/disposable.js.src.html +1 -1
  97. package/docs/source/lib/goog/disposable/idisposable.js.src.html +1 -1
  98. package/docs/source/lib/goog/dom/browserfeature.js.src.html +1 -1
  99. package/docs/source/lib/goog/dom/dom.js.src.html +1 -1
  100. package/docs/source/lib/goog/dom/nodetype.js.src.html +1 -1
  101. package/docs/source/lib/goog/dom/tagname.js.src.html +1 -1
  102. package/docs/source/lib/goog/dom/vendor.js.src.html +1 -1
  103. package/docs/source/lib/goog/events/browserevent.js.src.html +1 -1
  104. package/docs/source/lib/goog/events/browserfeature.js.src.html +1 -1
  105. package/docs/source/lib/goog/events/event.js.src.html +1 -1
  106. package/docs/source/lib/goog/events/eventid.js.src.html +1 -1
  107. package/docs/source/lib/goog/events/events.js.src.html +1 -1
  108. package/docs/source/lib/goog/events/eventtarget.js.src.html +1 -1
  109. package/docs/source/lib/goog/events/eventtype.js.src.html +1 -1
  110. package/docs/source/lib/goog/events/keycodes.js.src.html +1 -1
  111. package/docs/source/lib/goog/events/listenable.js.src.html +1 -1
  112. package/docs/source/lib/goog/events/listener.js.src.html +1 -1
  113. package/docs/source/lib/goog/events/listenermap.js.src.html +1 -1
  114. package/docs/source/lib/goog/functions/functions.js.src.html +1 -1
  115. package/docs/source/lib/goog/iter/iter.js.src.html +1 -1
  116. package/docs/source/lib/goog/json/json.js.src.html +1 -1
  117. package/docs/source/lib/goog/labs/testing/assertthat.js.src.html +1 -1
  118. package/docs/source/lib/goog/labs/testing/logicmatcher.js.src.html +1 -1
  119. package/docs/source/lib/goog/labs/testing/matcher.js.src.html +1 -1
  120. package/docs/source/lib/goog/labs/testing/numbermatcher.js.src.html +1 -1
  121. package/docs/source/lib/goog/labs/testing/objectmatcher.js.src.html +1 -1
  122. package/docs/source/lib/goog/labs/testing/stringmatcher.js.src.html +1 -1
  123. package/docs/source/lib/goog/labs/useragent/browser.js.src.html +1 -1
  124. package/docs/source/lib/goog/labs/useragent/engine.js.src.html +1 -1
  125. package/docs/source/lib/goog/labs/useragent/util.js.src.html +1 -1
  126. package/docs/source/lib/goog/math/box.js.src.html +1 -1
  127. package/docs/source/lib/goog/math/coordinate.js.src.html +1 -1
  128. package/docs/source/lib/goog/math/math.js.src.html +1 -1
  129. package/docs/source/lib/goog/math/rect.js.src.html +1 -1
  130. package/docs/source/lib/goog/math/size.js.src.html +1 -1
  131. package/docs/source/lib/goog/net/wrapperxmlhttpfactory.js.src.html +1 -1
  132. package/docs/source/lib/goog/net/xhrlike.js.src.html +1 -1
  133. package/docs/source/lib/goog/net/xmlhttp.js.src.html +1 -1
  134. package/docs/source/lib/goog/net/xmlhttpfactory.js.src.html +1 -1
  135. package/docs/source/lib/goog/object/object.js.src.html +1 -1
  136. package/docs/source/lib/goog/reflect/reflect.js.src.html +1 -1
  137. package/docs/source/lib/goog/string/string.js.src.html +1 -1
  138. package/docs/source/lib/goog/structs/collection.js.src.html +1 -1
  139. package/docs/source/lib/goog/structs/map.js.src.html +1 -1
  140. package/docs/source/lib/goog/structs/set.js.src.html +1 -1
  141. package/docs/source/lib/goog/structs/structs.js.src.html +1 -1
  142. package/docs/source/lib/goog/style/style.js.src.html +1 -1
  143. package/docs/source/lib/goog/testing/asserts.js.src.html +1 -1
  144. package/docs/source/lib/goog/testing/asynctestcase.js.src.html +1 -1
  145. package/docs/source/lib/goog/testing/events/events.js.src.html +1 -1
  146. package/docs/source/lib/goog/testing/functionmock.js.src.html +1 -1
  147. package/docs/source/lib/goog/testing/jsunit.js.src.html +1 -1
  148. package/docs/source/lib/goog/testing/loosemock.js.src.html +1 -1
  149. package/docs/source/lib/goog/testing/mock.js.src.html +1 -1
  150. package/docs/source/lib/goog/testing/mockclock.js.src.html +1 -1
  151. package/docs/source/lib/goog/testing/mockcontrol.js.src.html +1 -1
  152. package/docs/source/lib/goog/testing/mockinterface.js.src.html +1 -1
  153. package/docs/source/lib/goog/testing/mockmatchers.js.src.html +1 -1
  154. package/docs/source/lib/goog/testing/objectpropertystring.js.src.html +1 -1
  155. package/docs/source/lib/goog/testing/propertyreplacer.js.src.html +1 -1
  156. package/docs/source/lib/goog/testing/recordfunction.js.src.html +1 -1
  157. package/docs/source/lib/goog/testing/stacktrace.js.src.html +1 -1
  158. package/docs/source/lib/goog/testing/strictmock.js.src.html +1 -1
  159. package/docs/source/lib/goog/testing/testcase.js.src.html +1 -1
  160. package/docs/source/lib/goog/testing/testrunner.js.src.html +1 -1
  161. package/docs/source/lib/goog/testing/watchers.js.src.html +1 -1
  162. package/docs/source/lib/goog/uri/uri.js.src.html +1 -1
  163. package/docs/source/lib/goog/uri/utils.js.src.html +1 -1
  164. package/docs/source/lib/goog/useragent/product.js.src.html +1 -1
  165. package/docs/source/lib/goog/useragent/product_isversion.js.src.html +1 -1
  166. package/docs/source/lib/goog/useragent/useragent.js.src.html +1 -1
  167. package/docs/source/lib/webdriver/abstractbuilder.js.src.html +1 -1
  168. package/docs/source/lib/webdriver/actionsequence.js.src.html +1 -1
  169. package/docs/source/lib/webdriver/builder.js.src.html +1 -1
  170. package/docs/source/lib/webdriver/button.js.src.html +1 -1
  171. package/docs/source/lib/webdriver/capabilities.js.src.html +1 -1
  172. package/docs/source/lib/webdriver/command.js.src.html +1 -1
  173. package/docs/source/lib/webdriver/events.js.src.html +1 -1
  174. package/docs/source/lib/webdriver/firefoxdomexecutor.js.src.html +1 -1
  175. package/docs/source/lib/webdriver/http/corsclient.js.src.html +1 -1
  176. package/docs/source/lib/webdriver/http/http.js.src.html +1 -1
  177. package/docs/source/lib/webdriver/http/xhrclient.js.src.html +1 -1
  178. package/docs/source/lib/webdriver/key.js.src.html +1 -1
  179. package/docs/source/lib/webdriver/locators.js.src.html +1 -1
  180. package/docs/source/lib/webdriver/logging.js.src.html +1 -1
  181. package/docs/source/lib/webdriver/process.js.src.html +1 -1
  182. package/docs/source/lib/webdriver/promise.js.src.html +1 -1
  183. package/docs/source/lib/webdriver/session.js.src.html +1 -1
  184. package/docs/source/lib/webdriver/stacktrace.js.src.html +1 -1
  185. package/docs/source/lib/webdriver/testing/asserts.js.src.html +1 -1
  186. package/docs/source/lib/webdriver/testing/testcase.js.src.html +1 -1
  187. package/docs/source/lib/webdriver/until.js.src.html +1 -0
  188. package/docs/source/lib/webdriver/webdriver.js.src.html +1 -1
  189. package/docs/source/net/index.js.src.html +1 -1
  190. package/docs/source/net/portprober.js.src.html +1 -1
  191. package/docs/source/phantomjs.js.src.html +1 -1
  192. package/docs/source/proxy.js.src.html +1 -1
  193. package/docs/source/remote/index.js.src.html +1 -1
  194. package/docs/source/testing/assert.js.src.html +1 -1
  195. package/docs/source/testing/index.js.src.html +1 -1
  196. package/docs/types.js +1 -1
  197. package/example/google_search.js +9 -17
  198. package/example/google_search_generator.js +6 -7
  199. package/example/google_search_test.js +10 -18
  200. package/example/parallel_flows.js +4 -7
  201. package/index.js +6 -0
  202. package/lib/firefox/webdriver.xpi +0 -0
  203. package/lib/goog/deps.js +7 -5
  204. package/lib/test/index.js +0 -8
  205. package/lib/webdriver/promise.js +263 -251
  206. package/lib/webdriver/stacktrace.js +15 -1
  207. package/lib/webdriver/test/promise_flow_test.js +82 -76
  208. package/lib/webdriver/test/promise_test.js +22 -62
  209. package/lib/webdriver/test/stacktrace_test.js +18 -0
  210. package/lib/webdriver/test/until_test.js +388 -0
  211. package/lib/webdriver/test/webdriver_test.js +41 -0
  212. package/lib/webdriver/until.js +408 -0
  213. package/lib/webdriver/webdriver.js +91 -29
  214. package/package.json +2 -2
  215. package/test/element_finding_test.js +6 -6
  216. package/test/http/util_test.js +4 -5
  217. package/test/page_loading_test.js +7 -7
  218. package/test/stale_element_test.js +2 -10
  219. package/testing/index.js +9 -22
package/docs/source/_base.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>_base.js</title><link href="../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>_base.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2012 Selenium committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2012 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 &quot;License&quot;);<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 &quot;AS IS&quot; 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>/**<tr><td><a name="l17" href="#l17">17</a><td> * @fileoverview The base module responsible for bootstrapping the Closure<tr><td><a name="l18" href="#l18">18</a><td> * library and providing a means of loading Closure-based modules.<tr><td><a name="l19" href="#l19">19</a><td> *<tr><td><a name="l20" href="#l20">20</a><td> * &lt;p&gt;Each script loaded by this module will be granted access to this module&#39;s<tr><td><a name="l21" href="#l21">21</a><td> * {@code require} function; all required non-native modules must be specified<tr><td><a name="l22" href="#l22">22</a><td> * relative to &lt;em&gt;this&lt;/em&gt; module.<tr><td><a name="l23" href="#l23">23</a><td> *<tr><td><a name="l24" href="#l24">24</a><td> * &lt;p&gt;This module will load all scripts from the &quot;lib&quot; subdirectory, unless the<tr><td><a name="l25" href="#l25">25</a><td> * SELENIUM_DEV_MODE environment variable has been set to 1, in which case all<tr><td><a name="l26" href="#l26">26</a><td> * scripts will be loaded from the Selenium client containing this script.<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>&#39;use strict&#39;;<tr><td><a name="l30" href="#l30">30</a><td><tr><td><a name="l31" href="#l31">31</a><td>var fs = require(&#39;fs&#39;),<tr><td><a name="l32" href="#l32">32</a><td> path = require(&#39;path&#39;),<tr><td><a name="l33" href="#l33">33</a><td> vm = require(&#39;vm&#39;);<tr><td><a name="l34" href="#l34">34</a><td><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> * If this script was loaded from the Selenium project repo, it will operate in<tr><td><a name="l38" href="#l38">38</a><td> * development mode, adjusting how it loads Closure-based dependencies.<tr><td><a name="l39" href="#l39">39</a><td> * @type {boolean}<tr><td><a name="l40" href="#l40">40</a><td> */<tr><td><a name="l41" href="#l41">41</a><td>var devMode = (function() {<tr><td><a name="l42" href="#l42">42</a><td> var buildDescFile = path.join(__dirname, &#39;..&#39;, &#39;build.desc&#39;);<tr><td><a name="l43" href="#l43">43</a><td> return fs.existsSync(buildDescFile);<tr><td><a name="l44" href="#l44">44</a><td>})();<tr><td><a name="l45" href="#l45">45</a><td><tr><td><a name="l46" href="#l46">46</a><td><tr><td><a name="l47" href="#l47">47</a><td>/** @return {boolean} Whether this script was loaded in dev mode. */<tr><td><a name="l48" href="#l48">48</a><td>function isDevMode() {<tr><td><a name="l49" href="#l49">49</a><td> return devMode;<tr><td><a name="l50" href="#l50">50</a><td>}<tr><td><a name="l51" href="#l51">51</a><td><tr><td><a name="l52" href="#l52">52</a><td><tr><td><a name="l53" href="#l53">53</a><td>/**<tr><td><a name="l54" href="#l54">54</a><td> * @type {string} Path to Closure&#39;s base file, relative to this module.<tr><td><a name="l55" href="#l55">55</a><td> * @const<tr><td><a name="l56" href="#l56">56</a><td> */<tr><td><a name="l57" href="#l57">57</a><td>var CLOSURE_BASE_FILE_PATH = (function() {<tr><td><a name="l58" href="#l58">58</a><td> var relativePath = isDevMode() ?<tr><td><a name="l59" href="#l59">59</a><td> &#39;../../../third_party/closure/goog/base.js&#39; :<tr><td><a name="l60" href="#l60">60</a><td> &#39;./lib/goog/base.js&#39;;<tr><td><a name="l61" href="#l61">61</a><td> return path.join(__dirname, relativePath);<tr><td><a name="l62" href="#l62">62</a><td>})();<tr><td><a name="l63" href="#l63">63</a><td><tr><td><a name="l64" href="#l64">64</a><td><tr><td><a name="l65" href="#l65">65</a><td>/**<tr><td><a name="l66" href="#l66">66</a><td> * @type {string} Path to Closure&#39;s base file, relative to this module.<tr><td><a name="l67" href="#l67">67</a><td> * @const<tr><td><a name="l68" href="#l68">68</a><td> */<tr><td><a name="l69" href="#l69">69</a><td>var DEPS_FILE_PATH = (function() {<tr><td><a name="l70" href="#l70">70</a><td> var relativePath = isDevMode() ?<tr><td><a name="l71" href="#l71">71</a><td> &#39;../../../javascript/deps.js&#39; :<tr><td><a name="l72" href="#l72">72</a><td> &#39;./lib/goog/deps.js&#39;;<tr><td><a name="l73" href="#l73">73</a><td> return path.join(__dirname, relativePath);<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><tr><td><a name="l77" href="#l77">77</a><td>/**<tr><td><a name="l78" href="#l78">78</a><td> * Maintains a unique context for Closure library-based code.<tr><td><a name="l79" href="#l79">79</a><td> * @param {boolean=} opt_configureForTesting Whether to configure a fake DOM<tr><td><a name="l80" href="#l80">80</a><td> * for Closure-testing code that (incorrectly) assumes a DOM is always<tr><td><a name="l81" href="#l81">81</a><td> * present.<tr><td><a name="l82" href="#l82">82</a><td> * @constructor<tr><td><a name="l83" href="#l83">83</a><td> */<tr><td><a name="l84" href="#l84">84</a><td>function Context(opt_configureForTesting) {<tr><td><a name="l85" href="#l85">85</a><td> var closure = this.closure = vm.createContext({<tr><td><a name="l86" href="#l86">86</a><td> console: console,<tr><td><a name="l87" href="#l87">87</a><td> setTimeout: setTimeout,<tr><td><a name="l88" href="#l88">88</a><td> setInterval: setInterval,<tr><td><a name="l89" href="#l89">89</a><td> clearTimeout: clearTimeout,<tr><td><a name="l90" href="#l90">90</a><td> clearInterval: clearInterval,<tr><td><a name="l91" href="#l91">91</a><td> process: process,<tr><td><a name="l92" href="#l92">92</a><td> require: require,<tr><td><a name="l93" href="#l93">93</a><td> Buffer: Buffer,<tr><td><a name="l94" href="#l94">94</a><td> Error: Error,<tr><td><a name="l95" href="#l95">95</a><td> CLOSURE_BASE_PATH: path.dirname(CLOSURE_BASE_FILE_PATH) + &#39;/&#39;,<tr><td><a name="l96" href="#l96">96</a><td> CLOSURE_IMPORT_SCRIPT: function(src) {<tr><td><a name="l97" href="#l97">97</a><td> loadScript(src);<tr><td><a name="l98" href="#l98">98</a><td> return true;<tr><td><a name="l99" href="#l99">99</a><td> },<tr><td><a name="l100" href="#l100">100</a><td> CLOSURE_NO_DEPS: !isDevMode(),<tr><td><a name="l101" href="#l101">101</a><td> goog: {}<tr><td><a name="l102" href="#l102">102</a><td> });<tr><td><a name="l103" href="#l103">103</a><td> closure.window = closure.top = closure;<tr><td><a name="l104" href="#l104">104</a><td><tr><td><a name="l105" href="#l105">105</a><td> if (opt_configureForTesting) {<tr><td><a name="l106" href="#l106">106</a><td> closure.document = {<tr><td><a name="l107" href="#l107">107</a><td> body: {},<tr><td><a name="l108" href="#l108">108</a><td> createElement: function() { return {}; },<tr><td><a name="l109" href="#l109">109</a><td> getElementsByTagName: function() { return []; }<tr><td><a name="l110" href="#l110">110</a><td> };<tr><td><a name="l111" href="#l111">111</a><td> closure.document.body.ownerDocument = closure.document;<tr><td><a name="l112" href="#l112">112</a><td> }<tr><td><a name="l113" href="#l113">113</a><td><tr><td><a name="l114" href="#l114">114</a><td> loadScript(CLOSURE_BASE_FILE_PATH);<tr><td><a name="l115" href="#l115">115</a><td> loadScript(DEPS_FILE_PATH);<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> * Synchronously loads a script into the protected Closure context.<tr><td><a name="l119" href="#l119">119</a><td> * @param {string} src Path to the file to load.<tr><td><a name="l120" href="#l120">120</a><td> */<tr><td><a name="l121" href="#l121">121</a><td> function loadScript(src) {<tr><td><a name="l122" href="#l122">122</a><td> src = path.normalize(src);<tr><td><a name="l123" href="#l123">123</a><td> var contents = fs.readFileSync(src, &#39;utf8&#39;);<tr><td><a name="l124" href="#l124">124</a><td> vm.runInContext(contents, closure, src);<tr><td><a name="l125" href="#l125">125</a><td> }<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>var context = new Context();<tr><td><a name="l130" href="#l130">130</a><td><tr><td><a name="l131" href="#l131">131</a><td><tr><td><a name="l132" href="#l132">132</a><td>/**<tr><td><a name="l133" href="#l133">133</a><td> * Loads a symbol by name from the protected Closure context.<tr><td><a name="l134" href="#l134">134</a><td> * @param {string} symbol The symbol to load.<tr><td><a name="l135" href="#l135">135</a><td> * @return {?} The loaded symbol, or {@code null} if not found.<tr><td><a name="l136" href="#l136">136</a><td> * @throws {Error} If the symbol has not been defined.<tr><td><a name="l137" href="#l137">137</a><td> */<tr><td><a name="l138" href="#l138">138</a><td>function closureRequire(symbol) {<tr><td><a name="l139" href="#l139">139</a><td> context.closure.goog.require(symbol);<tr><td><a name="l140" href="#l140">140</a><td> return context.closure.goog.getObjectByName(symbol);<tr><td><a name="l141" href="#l141">141</a><td>}<tr><td><a name="l142" href="#l142">142</a><td><tr><td><a name="l143" href="#l143">143</a><td><tr><td><a name="l144" href="#l144">144</a><td>// PUBLIC API<tr><td><a name="l145" href="#l145">145</a><td><tr><td><a name="l146" href="#l146">146</a><td><tr><td><a name="l147" href="#l147">147</a><td>/**<tr><td><a name="l148" href="#l148">148</a><td> * Loads a symbol by name from the protected Closure context and exports its<tr><td><a name="l149" href="#l149">149</a><td> * public API to the provided object. This function relies on Closure code<tr><td><a name="l150" href="#l150">150</a><td> * conventions to define the public API of an object as those properties whose<tr><td><a name="l151" href="#l151">151</a><td> * name does not end with &quot;_&quot;.<tr><td><a name="l152" href="#l152">152</a><td> * @param {string} symbol The symbol to load. This must resolve to an object.<tr><td><a name="l153" href="#l153">153</a><td> * @return {!Object} An object with the exported API.<tr><td><a name="l154" href="#l154">154</a><td> * @throws {Error} If the symbol has not been defined or does not resolve to<tr><td><a name="l155" href="#l155">155</a><td> * an object.<tr><td><a name="l156" href="#l156">156</a><td> */<tr><td><a name="l157" href="#l157">157</a><td>exports.exportPublicApi = function(symbol) {<tr><td><a name="l158" href="#l158">158</a><td> var src = closureRequire(symbol);<tr><td><a name="l159" href="#l159">159</a><td> if (typeof src != &#39;object&#39; || src === null) {<tr><td><a name="l160" href="#l160">160</a><td> throw Error(&#39;&quot;&#39; + symbol + &#39;&quot; must resolve to an object&#39;);<tr><td><a name="l161" href="#l161">161</a><td> }<tr><td><a name="l162" href="#l162">162</a><td><tr><td><a name="l163" href="#l163">163</a><td> var dest = {};<tr><td><a name="l164" href="#l164">164</a><td> Object.keys(src).forEach(function(key) {<tr><td><a name="l165" href="#l165">165</a><td> if (key[key.length - 1] != &#39;_&#39;) {<tr><td><a name="l166" href="#l166">166</a><td> dest[key] = src[key];<tr><td><a name="l167" href="#l167">167</a><td> }<tr><td><a name="l168" href="#l168">168</a><td> });<tr><td><a name="l169" href="#l169">169</a><td><tr><td><a name="l170" href="#l170">170</a><td> return dest;<tr><td><a name="l171" href="#l171">171</a><td>};<tr><td><a name="l172" href="#l172">172</a><td><tr><td><a name="l173" href="#l173">173</a><td><tr><td><a name="l174" href="#l174">174</a><td>if (isDevMode()) {<tr><td><a name="l175" href="#l175">175</a><td> exports.closure = context.closure;<tr><td><a name="l176" href="#l176">176</a><td>}<tr><td><a name="l177" href="#l177">177</a><td>exports.Context = Context;<tr><td><a name="l178" href="#l178">178</a><td>exports.isDevMode = isDevMode;<tr><td><a name="l179" href="#l179">179</a><td>exports.require = closureRequire;</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>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</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>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>_base.js</title><link href="../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>_base.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2012 Selenium committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2012 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 &quot;License&quot;);<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 &quot;AS IS&quot; 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>/**<tr><td><a name="l17" href="#l17">17</a><td> * @fileoverview The base module responsible for bootstrapping the Closure<tr><td><a name="l18" href="#l18">18</a><td> * library and providing a means of loading Closure-based modules.<tr><td><a name="l19" href="#l19">19</a><td> *<tr><td><a name="l20" href="#l20">20</a><td> * &lt;p&gt;Each script loaded by this module will be granted access to this module&#39;s<tr><td><a name="l21" href="#l21">21</a><td> * {@code require} function; all required non-native modules must be specified<tr><td><a name="l22" href="#l22">22</a><td> * relative to &lt;em&gt;this&lt;/em&gt; module.<tr><td><a name="l23" href="#l23">23</a><td> *<tr><td><a name="l24" href="#l24">24</a><td> * &lt;p&gt;This module will load all scripts from the &quot;lib&quot; subdirectory, unless the<tr><td><a name="l25" href="#l25">25</a><td> * SELENIUM_DEV_MODE environment variable has been set to 1, in which case all<tr><td><a name="l26" href="#l26">26</a><td> * scripts will be loaded from the Selenium client containing this script.<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>&#39;use strict&#39;;<tr><td><a name="l30" href="#l30">30</a><td><tr><td><a name="l31" href="#l31">31</a><td>var fs = require(&#39;fs&#39;),<tr><td><a name="l32" href="#l32">32</a><td> path = require(&#39;path&#39;),<tr><td><a name="l33" href="#l33">33</a><td> vm = require(&#39;vm&#39;);<tr><td><a name="l34" href="#l34">34</a><td><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> * If this script was loaded from the Selenium project repo, it will operate in<tr><td><a name="l38" href="#l38">38</a><td> * development mode, adjusting how it loads Closure-based dependencies.<tr><td><a name="l39" href="#l39">39</a><td> * @type {boolean}<tr><td><a name="l40" href="#l40">40</a><td> */<tr><td><a name="l41" href="#l41">41</a><td>var devMode = (function() {<tr><td><a name="l42" href="#l42">42</a><td> var buildDescFile = path.join(__dirname, &#39;..&#39;, &#39;build.desc&#39;);<tr><td><a name="l43" href="#l43">43</a><td> return fs.existsSync(buildDescFile);<tr><td><a name="l44" href="#l44">44</a><td>})();<tr><td><a name="l45" href="#l45">45</a><td><tr><td><a name="l46" href="#l46">46</a><td><tr><td><a name="l47" href="#l47">47</a><td>/** @return {boolean} Whether this script was loaded in dev mode. */<tr><td><a name="l48" href="#l48">48</a><td>function isDevMode() {<tr><td><a name="l49" href="#l49">49</a><td> return devMode;<tr><td><a name="l50" href="#l50">50</a><td>}<tr><td><a name="l51" href="#l51">51</a><td><tr><td><a name="l52" href="#l52">52</a><td><tr><td><a name="l53" href="#l53">53</a><td>/**<tr><td><a name="l54" href="#l54">54</a><td> * @type {string} Path to Closure&#39;s base file, relative to this module.<tr><td><a name="l55" href="#l55">55</a><td> * @const<tr><td><a name="l56" href="#l56">56</a><td> */<tr><td><a name="l57" href="#l57">57</a><td>var CLOSURE_BASE_FILE_PATH = (function() {<tr><td><a name="l58" href="#l58">58</a><td> var relativePath = isDevMode() ?<tr><td><a name="l59" href="#l59">59</a><td> &#39;../../../third_party/closure/goog/base.js&#39; :<tr><td><a name="l60" href="#l60">60</a><td> &#39;./lib/goog/base.js&#39;;<tr><td><a name="l61" href="#l61">61</a><td> return path.join(__dirname, relativePath);<tr><td><a name="l62" href="#l62">62</a><td>})();<tr><td><a name="l63" href="#l63">63</a><td><tr><td><a name="l64" href="#l64">64</a><td><tr><td><a name="l65" href="#l65">65</a><td>/**<tr><td><a name="l66" href="#l66">66</a><td> * @type {string} Path to Closure&#39;s base file, relative to this module.<tr><td><a name="l67" href="#l67">67</a><td> * @const<tr><td><a name="l68" href="#l68">68</a><td> */<tr><td><a name="l69" href="#l69">69</a><td>var DEPS_FILE_PATH = (function() {<tr><td><a name="l70" href="#l70">70</a><td> var relativePath = isDevMode() ?<tr><td><a name="l71" href="#l71">71</a><td> &#39;../../../javascript/deps.js&#39; :<tr><td><a name="l72" href="#l72">72</a><td> &#39;./lib/goog/deps.js&#39;;<tr><td><a name="l73" href="#l73">73</a><td> return path.join(__dirname, relativePath);<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><tr><td><a name="l77" href="#l77">77</a><td>/**<tr><td><a name="l78" href="#l78">78</a><td> * Maintains a unique context for Closure library-based code.<tr><td><a name="l79" href="#l79">79</a><td> * @param {boolean=} opt_configureForTesting Whether to configure a fake DOM<tr><td><a name="l80" href="#l80">80</a><td> * for Closure-testing code that (incorrectly) assumes a DOM is always<tr><td><a name="l81" href="#l81">81</a><td> * present.<tr><td><a name="l82" href="#l82">82</a><td> * @constructor<tr><td><a name="l83" href="#l83">83</a><td> */<tr><td><a name="l84" href="#l84">84</a><td>function Context(opt_configureForTesting) {<tr><td><a name="l85" href="#l85">85</a><td> var closure = this.closure = vm.createContext({<tr><td><a name="l86" href="#l86">86</a><td> console: console,<tr><td><a name="l87" href="#l87">87</a><td> setTimeout: setTimeout,<tr><td><a name="l88" href="#l88">88</a><td> setInterval: setInterval,<tr><td><a name="l89" href="#l89">89</a><td> clearTimeout: clearTimeout,<tr><td><a name="l90" href="#l90">90</a><td> clearInterval: clearInterval,<tr><td><a name="l91" href="#l91">91</a><td> process: process,<tr><td><a name="l92" href="#l92">92</a><td> require: require,<tr><td><a name="l93" href="#l93">93</a><td> Buffer: Buffer,<tr><td><a name="l94" href="#l94">94</a><td> Error: Error,<tr><td><a name="l95" href="#l95">95</a><td> CLOSURE_BASE_PATH: path.dirname(CLOSURE_BASE_FILE_PATH) + &#39;/&#39;,<tr><td><a name="l96" href="#l96">96</a><td> CLOSURE_IMPORT_SCRIPT: function(src) {<tr><td><a name="l97" href="#l97">97</a><td> loadScript(src);<tr><td><a name="l98" href="#l98">98</a><td> return true;<tr><td><a name="l99" href="#l99">99</a><td> },<tr><td><a name="l100" href="#l100">100</a><td> CLOSURE_NO_DEPS: !isDevMode(),<tr><td><a name="l101" href="#l101">101</a><td> goog: {}<tr><td><a name="l102" href="#l102">102</a><td> });<tr><td><a name="l103" href="#l103">103</a><td> closure.window = closure.top = closure;<tr><td><a name="l104" href="#l104">104</a><td><tr><td><a name="l105" href="#l105">105</a><td> if (opt_configureForTesting) {<tr><td><a name="l106" href="#l106">106</a><td> closure.document = {<tr><td><a name="l107" href="#l107">107</a><td> body: {},<tr><td><a name="l108" href="#l108">108</a><td> createElement: function() { return {}; },<tr><td><a name="l109" href="#l109">109</a><td> getElementsByTagName: function() { return []; }<tr><td><a name="l110" href="#l110">110</a><td> };<tr><td><a name="l111" href="#l111">111</a><td> closure.document.body.ownerDocument = closure.document;<tr><td><a name="l112" href="#l112">112</a><td> }<tr><td><a name="l113" href="#l113">113</a><td><tr><td><a name="l114" href="#l114">114</a><td> loadScript(CLOSURE_BASE_FILE_PATH);<tr><td><a name="l115" href="#l115">115</a><td> loadScript(DEPS_FILE_PATH);<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> * Synchronously loads a script into the protected Closure context.<tr><td><a name="l119" href="#l119">119</a><td> * @param {string} src Path to the file to load.<tr><td><a name="l120" href="#l120">120</a><td> */<tr><td><a name="l121" href="#l121">121</a><td> function loadScript(src) {<tr><td><a name="l122" href="#l122">122</a><td> src = path.normalize(src);<tr><td><a name="l123" href="#l123">123</a><td> var contents = fs.readFileSync(src, &#39;utf8&#39;);<tr><td><a name="l124" href="#l124">124</a><td> vm.runInContext(contents, closure, src);<tr><td><a name="l125" href="#l125">125</a><td> }<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>var context = new Context();<tr><td><a name="l130" href="#l130">130</a><td><tr><td><a name="l131" href="#l131">131</a><td><tr><td><a name="l132" href="#l132">132</a><td>/**<tr><td><a name="l133" href="#l133">133</a><td> * Loads a symbol by name from the protected Closure context.<tr><td><a name="l134" href="#l134">134</a><td> * @param {string} symbol The symbol to load.<tr><td><a name="l135" href="#l135">135</a><td> * @return {?} The loaded symbol, or {@code null} if not found.<tr><td><a name="l136" href="#l136">136</a><td> * @throws {Error} If the symbol has not been defined.<tr><td><a name="l137" href="#l137">137</a><td> */<tr><td><a name="l138" href="#l138">138</a><td>function closureRequire(symbol) {<tr><td><a name="l139" href="#l139">139</a><td> context.closure.goog.require(symbol);<tr><td><a name="l140" href="#l140">140</a><td> return context.closure.goog.getObjectByName(symbol);<tr><td><a name="l141" href="#l141">141</a><td>}<tr><td><a name="l142" href="#l142">142</a><td><tr><td><a name="l143" href="#l143">143</a><td><tr><td><a name="l144" href="#l144">144</a><td>// PUBLIC API<tr><td><a name="l145" href="#l145">145</a><td><tr><td><a name="l146" href="#l146">146</a><td><tr><td><a name="l147" href="#l147">147</a><td>/**<tr><td><a name="l148" href="#l148">148</a><td> * Loads a symbol by name from the protected Closure context and exports its<tr><td><a name="l149" href="#l149">149</a><td> * public API to the provided object. This function relies on Closure code<tr><td><a name="l150" href="#l150">150</a><td> * conventions to define the public API of an object as those properties whose<tr><td><a name="l151" href="#l151">151</a><td> * name does not end with &quot;_&quot;.<tr><td><a name="l152" href="#l152">152</a><td> * @param {string} symbol The symbol to load. This must resolve to an object.<tr><td><a name="l153" href="#l153">153</a><td> * @return {!Object} An object with the exported API.<tr><td><a name="l154" href="#l154">154</a><td> * @throws {Error} If the symbol has not been defined or does not resolve to<tr><td><a name="l155" href="#l155">155</a><td> * an object.<tr><td><a name="l156" href="#l156">156</a><td> */<tr><td><a name="l157" href="#l157">157</a><td>exports.exportPublicApi = function(symbol) {<tr><td><a name="l158" href="#l158">158</a><td> var src = closureRequire(symbol);<tr><td><a name="l159" href="#l159">159</a><td> if (typeof src != &#39;object&#39; || src === null) {<tr><td><a name="l160" href="#l160">160</a><td> throw Error(&#39;&quot;&#39; + symbol + &#39;&quot; must resolve to an object&#39;);<tr><td><a name="l161" href="#l161">161</a><td> }<tr><td><a name="l162" href="#l162">162</a><td><tr><td><a name="l163" href="#l163">163</a><td> var dest = {};<tr><td><a name="l164" href="#l164">164</a><td> Object.keys(src).forEach(function(key) {<tr><td><a name="l165" href="#l165">165</a><td> if (key[key.length - 1] != &#39;_&#39;) {<tr><td><a name="l166" href="#l166">166</a><td> dest[key] = src[key];<tr><td><a name="l167" href="#l167">167</a><td> }<tr><td><a name="l168" href="#l168">168</a><td> });<tr><td><a name="l169" href="#l169">169</a><td><tr><td><a name="l170" href="#l170">170</a><td> return dest;<tr><td><a name="l171" href="#l171">171</a><td>};<tr><td><a name="l172" href="#l172">172</a><td><tr><td><a name="l173" href="#l173">173</a><td><tr><td><a name="l174" href="#l174">174</a><td>if (isDevMode()) {<tr><td><a name="l175" href="#l175">175</a><td> exports.closure = context.closure;<tr><td><a name="l176" href="#l176">176</a><td>}<tr><td><a name="l177" href="#l177">177</a><td>exports.Context = Context;<tr><td><a name="l178" href="#l178">178</a><td>exports.isDevMode = isDevMode;<tr><td><a name="l179" href="#l179">179</a><td>exports.require = closureRequire;</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>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</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>
package/docs/source/builder.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>builder.js</title><link href="../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>builder.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 Software Freedom Conservancy. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>var base = require(&#39;./_base&#39;),<tr><td><a name="l16" href="#l16">16</a><td> executors = require(&#39;./executors&#39;);<tr><td><a name="l17" href="#l17">17</a><td><tr><td><a name="l18" href="#l18">18</a><td>// Use base.require to avoid circular references between index and this module.<tr><td><a name="l19" href="#l19">19</a><td>var Browser = base.require(&#39;webdriver.Browser&#39;),<tr><td><a name="l20" href="#l20">20</a><td> Capabilities = base.require(&#39;webdriver.Capabilities&#39;),<tr><td><a name="l21" href="#l21">21</a><td> Capability = base.require(&#39;webdriver.Capability&#39;),<tr><td><a name="l22" href="#l22">22</a><td> WebDriver = base.require(&#39;webdriver.WebDriver&#39;),<tr><td><a name="l23" href="#l23">23</a><td> promise = base.require(&#39;webdriver.promise&#39;);<tr><td><a name="l24" href="#l24">24</a><td><tr><td><a name="l25" href="#l25">25</a><td><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> * Creates new {@link webdriver.WebDriver WebDriver} instances. The environment<tr><td><a name="l29" href="#l29">29</a><td> * variables listed below may be used to override a builder&#39;s configuration,<tr><td><a name="l30" href="#l30">30</a><td> * allowing quick runtime changes.<tr><td><a name="l31" href="#l31">31</a><td> * &lt;ul&gt;<tr><td><a name="l32" href="#l32">32</a><td> * &lt;li&gt;{@code SELENIUM_REMOTE_URL}: defines the remote URL for all builder<tr><td><a name="l33" href="#l33">33</a><td> * instances. This environment variable should be set to a fully qualified<tr><td><a name="l34" href="#l34">34</a><td> * URL for a WebDriver server (e.g. http://localhost:4444/wd/hub).<tr><td><a name="l35" href="#l35">35</a><td> *<tr><td><a name="l36" href="#l36">36</a><td> * &lt;li&gt;{@code SELENIUM_BROWSER}: defines the target browser in the form<tr><td><a name="l37" href="#l37">37</a><td> * {@code browser[:version][:platform]}.<tr><td><a name="l38" href="#l38">38</a><td> * &lt;/ul&gt;<tr><td><a name="l39" href="#l39">39</a><td> *<tr><td><a name="l40" href="#l40">40</a><td> * &lt;p&gt;Suppose you had mytest.js that created WebDriver with<tr><td><a name="l41" href="#l41">41</a><td> * {@code var driver = new webdriver.Builder().build();}.<tr><td><a name="l42" href="#l42">42</a><td> *<tr><td><a name="l43" href="#l43">43</a><td> * This test could be made to use Firefox on the local machine by running with<tr><td><a name="l44" href="#l44">44</a><td> * {@code SELENIUM_BROWSER=firefox node mytest.js}.<tr><td><a name="l45" href="#l45">45</a><td> *<tr><td><a name="l46" href="#l46">46</a><td> * &lt;p&gt;Alternatively, you could request Chrome 36 on Linux from a remote<tr><td><a name="l47" href="#l47">47</a><td> * server with {@code<tr><td><a name="l48" href="#l48">48</a><td> * SELENIUM_BROWSER=chrome:36:LINUX<tr><td><a name="l49" href="#l49">49</a><td> * SELENIUM_REMOTE_URL=http://www.example.com:4444/wd/hub<tr><td><a name="l50" href="#l50">50</a><td> * node mytest.js}.<tr><td><a name="l51" href="#l51">51</a><td> *<tr><td><a name="l52" href="#l52">52</a><td> * @constructor<tr><td><a name="l53" href="#l53">53</a><td> */<tr><td><a name="l54" href="#l54">54</a><td>var Builder = function() {<tr><td><a name="l55" href="#l55">55</a><td><tr><td><a name="l56" href="#l56">56</a><td> /** @private {webdriver.promise.ControlFlow} */<tr><td><a name="l57" href="#l57">57</a><td> this.flow_ = null;<tr><td><a name="l58" href="#l58">58</a><td><tr><td><a name="l59" href="#l59">59</a><td> /** @private {string} */<tr><td><a name="l60" href="#l60">60</a><td> this.url_ = &#39;&#39;;<tr><td><a name="l61" href="#l61">61</a><td><tr><td><a name="l62" href="#l62">62</a><td> /** @private {!webdriver.Capabilities} */<tr><td><a name="l63" href="#l63">63</a><td> this.capabilities_ = new Capabilities();<tr><td><a name="l64" href="#l64">64</a><td><tr><td><a name="l65" href="#l65">65</a><td> /** @private {chrome.Options} */<tr><td><a name="l66" href="#l66">66</a><td> this.chromeOptions_ = null;<tr><td><a name="l67" href="#l67">67</a><td><tr><td><a name="l68" href="#l68">68</a><td> /** @private {firefox.Options} */<tr><td><a name="l69" href="#l69">69</a><td> this.firefoxOptions_ = null;<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><tr><td><a name="l73" href="#l73">73</a><td>/**<tr><td><a name="l74" href="#l74">74</a><td> * Sets the URL of a remote WebDriver server to use. Once a remote URL has been<tr><td><a name="l75" href="#l75">75</a><td> * specified, the builder direct all new clients to that server. If this method<tr><td><a name="l76" href="#l76">76</a><td> * is never called, the Builder will attempt to create all clients locally.<tr><td><a name="l77" href="#l77">77</a><td> *<tr><td><a name="l78" href="#l78">78</a><td> * &lt;p&gt;As an alternative to this method, you may also set the<tr><td><a name="l79" href="#l79">79</a><td> * {@code SELENIUM_REMOTE_URL} environment variable.<tr><td><a name="l80" href="#l80">80</a><td> *<tr><td><a name="l81" href="#l81">81</a><td> * @param {string} url The URL of a remote server to use.<tr><td><a name="l82" href="#l82">82</a><td> * @return {!Builder} A self reference.<tr><td><a name="l83" href="#l83">83</a><td> */<tr><td><a name="l84" href="#l84">84</a><td>Builder.prototype.usingServer = function(url) {<tr><td><a name="l85" href="#l85">85</a><td> this.url_ = url;<tr><td><a name="l86" href="#l86">86</a><td> return this;<tr><td><a name="l87" href="#l87">87</a><td>};<tr><td><a name="l88" href="#l88">88</a><td><tr><td><a name="l89" href="#l89">89</a><td><tr><td><a name="l90" href="#l90">90</a><td>/**<tr><td><a name="l91" href="#l91">91</a><td> * @return {string} The URL of the WebDriver server this instance is configured<tr><td><a name="l92" href="#l92">92</a><td> * to use.<tr><td><a name="l93" href="#l93">93</a><td> */<tr><td><a name="l94" href="#l94">94</a><td>Builder.prototype.getServerUrl = function() {<tr><td><a name="l95" href="#l95">95</a><td> return this.url_;<tr><td><a name="l96" href="#l96">96</a><td>};<tr><td><a name="l97" href="#l97">97</a><td><tr><td><a name="l98" href="#l98">98</a><td><tr><td><a name="l99" href="#l99">99</a><td>/**<tr><td><a name="l100" href="#l100">100</a><td> * Sets the desired capabilities when requesting a new session. This will<tr><td><a name="l101" href="#l101">101</a><td> * overwrite any previously set capabilities.<tr><td><a name="l102" href="#l102">102</a><td> * @param {!(Object|webdriver.Capabilities)} capabilities The desired<tr><td><a name="l103" href="#l103">103</a><td> * capabilities for a new session.<tr><td><a name="l104" href="#l104">104</a><td> * @return {!Builder} A self reference.<tr><td><a name="l105" href="#l105">105</a><td> */<tr><td><a name="l106" href="#l106">106</a><td>Builder.prototype.withCapabilities = function(capabilities) {<tr><td><a name="l107" href="#l107">107</a><td> this.capabilities_ = new Capabilities(capabilities);<tr><td><a name="l108" href="#l108">108</a><td> return this;<tr><td><a name="l109" href="#l109">109</a><td>};<tr><td><a name="l110" href="#l110">110</a><td><tr><td><a name="l111" href="#l111">111</a><td><tr><td><a name="l112" href="#l112">112</a><td>/**<tr><td><a name="l113" href="#l113">113</a><td> * Returns the base set of capabilities this instance is currently configured<tr><td><a name="l114" href="#l114">114</a><td> * to use.<tr><td><a name="l115" href="#l115">115</a><td> * @return {!webdriver.Capabilities} The current capabilities for this builder.<tr><td><a name="l116" href="#l116">116</a><td> */<tr><td><a name="l117" href="#l117">117</a><td>Builder.prototype.getCapabilities = function() {<tr><td><a name="l118" href="#l118">118</a><td> return this.capabilities_;<tr><td><a name="l119" href="#l119">119</a><td>};<tr><td><a name="l120" href="#l120">120</a><td><tr><td><a name="l121" href="#l121">121</a><td><tr><td><a name="l122" href="#l122">122</a><td>/**<tr><td><a name="l123" href="#l123">123</a><td> * Configures the target browser for clients created by this instance.<tr><td><a name="l124" href="#l124">124</a><td> * Any calls to {@link #withCapabilities} after this function will<tr><td><a name="l125" href="#l125">125</a><td> * overwrite these settings.<tr><td><a name="l126" href="#l126">126</a><td> *<tr><td><a name="l127" href="#l127">127</a><td> * &lt;p&gt;You may also define the target browser using the {@code SELENIUM_BROWSER}<tr><td><a name="l128" href="#l128">128</a><td> * environment variable. If set, this environment variable should be of the<tr><td><a name="l129" href="#l129">129</a><td> * form {@code browser[:[version][:platform]]}.<tr><td><a name="l130" href="#l130">130</a><td> *<tr><td><a name="l131" href="#l131">131</a><td> * @param {(string|webdriver.Browser)} name The name of the target browser;<tr><td><a name="l132" href="#l132">132</a><td> * common defaults are available on the {@link webdriver.Browser} enum.<tr><td><a name="l133" href="#l133">133</a><td> * @param {string=} opt_version A desired version; may be omitted if any<tr><td><a name="l134" href="#l134">134</a><td> * version should be used.<tr><td><a name="l135" href="#l135">135</a><td> * @param {string=} opt_platform The desired platform; may be omitted if any<tr><td><a name="l136" href="#l136">136</a><td> * version may be used.<tr><td><a name="l137" href="#l137">137</a><td> * @return {!Builder} A self reference.<tr><td><a name="l138" href="#l138">138</a><td> */<tr><td><a name="l139" href="#l139">139</a><td>Builder.prototype.forBrowser = function(name, opt_version, opt_platform) {<tr><td><a name="l140" href="#l140">140</a><td> this.capabilities_.set(Capability.BROWSER_NAME, name);<tr><td><a name="l141" href="#l141">141</a><td> this.capabilities_.set(Capability.VERSION, opt_version || null);<tr><td><a name="l142" href="#l142">142</a><td> this.capabilities_.set(Capability.PLATFORM, opt_platform || null);<tr><td><a name="l143" href="#l143">143</a><td> return this;<tr><td><a name="l144" href="#l144">144</a><td>};<tr><td><a name="l145" href="#l145">145</a><td><tr><td><a name="l146" href="#l146">146</a><td><tr><td><a name="l147" href="#l147">147</a><td>/**<tr><td><a name="l148" href="#l148">148</a><td> * Sets the proxy configuration to use for WebDriver clients created by this<tr><td><a name="l149" href="#l149">149</a><td> * builder. Any calls to {@link #withCapabilities} after this function will<tr><td><a name="l150" href="#l150">150</a><td> * overwrite these settings.<tr><td><a name="l151" href="#l151">151</a><td> * @param {!webdriver.ProxyConfig} config The configuration to use.<tr><td><a name="l152" href="#l152">152</a><td> * @return {!Builder} A self reference.<tr><td><a name="l153" href="#l153">153</a><td> */<tr><td><a name="l154" href="#l154">154</a><td>Builder.prototype.setProxy = function(config) {<tr><td><a name="l155" href="#l155">155</a><td> this.capabilities_.setProxy(config);<tr><td><a name="l156" href="#l156">156</a><td> return this;<tr><td><a name="l157" href="#l157">157</a><td>};<tr><td><a name="l158" href="#l158">158</a><td><tr><td><a name="l159" href="#l159">159</a><td><tr><td><a name="l160" href="#l160">160</a><td>/**<tr><td><a name="l161" href="#l161">161</a><td> * Sets the logging preferences for the created session. Preferences may be<tr><td><a name="l162" href="#l162">162</a><td> * changed by repeated calls, or by calling {@link #withCapabilities}.<tr><td><a name="l163" href="#l163">163</a><td> * @param {!(webdriver.logging.Preferences|Object.&lt;string, string&gt;)} prefs The<tr><td><a name="l164" href="#l164">164</a><td> * desired logging preferences.<tr><td><a name="l165" href="#l165">165</a><td> * @return {!Builder} A self reference.<tr><td><a name="l166" href="#l166">166</a><td> */<tr><td><a name="l167" href="#l167">167</a><td>Builder.prototype.setLoggingPrefs = function(prefs) {<tr><td><a name="l168" href="#l168">168</a><td> this.capabilities_.setLoggingPrefs(prefs);<tr><td><a name="l169" href="#l169">169</a><td> return this;<tr><td><a name="l170" href="#l170">170</a><td>};<tr><td><a name="l171" href="#l171">171</a><td><tr><td><a name="l172" href="#l172">172</a><td><tr><td><a name="l173" href="#l173">173</a><td>/**<tr><td><a name="l174" href="#l174">174</a><td> * Sets whether native events should be used.<tr><td><a name="l175" href="#l175">175</a><td> * @param {boolean} enabled Whether to enable native events.<tr><td><a name="l176" href="#l176">176</a><td> * @return {!Builder} A self reference.<tr><td><a name="l177" href="#l177">177</a><td> */<tr><td><a name="l178" href="#l178">178</a><td>Builder.prototype.setEnableNativeEvents = function(enabled) {<tr><td><a name="l179" href="#l179">179</a><td> this.capabilities_.setEnableNativeEvents(enabled);<tr><td><a name="l180" href="#l180">180</a><td> return this;<tr><td><a name="l181" href="#l181">181</a><td>};<tr><td><a name="l182" href="#l182">182</a><td><tr><td><a name="l183" href="#l183">183</a><td><tr><td><a name="l184" href="#l184">184</a><td>/**<tr><td><a name="l185" href="#l185">185</a><td> * Sets how elements should be scrolled into view for interaction.<tr><td><a name="l186" href="#l186">186</a><td> * @param {number} behavior The desired scroll behavior: either 0 to align with<tr><td><a name="l187" href="#l187">187</a><td> * the top of the viewport or 1 to align with the bottom.<tr><td><a name="l188" href="#l188">188</a><td> * @return {!Builder} A self reference.<tr><td><a name="l189" href="#l189">189</a><td> */<tr><td><a name="l190" href="#l190">190</a><td>Builder.prototype.setScrollBehavior = function(behavior) {<tr><td><a name="l191" href="#l191">191</a><td> this.capabilities_.setScrollBehavior(behavior);<tr><td><a name="l192" href="#l192">192</a><td> return this;<tr><td><a name="l193" href="#l193">193</a><td>};<tr><td><a name="l194" href="#l194">194</a><td><tr><td><a name="l195" href="#l195">195</a><td><tr><td><a name="l196" href="#l196">196</a><td>/**<tr><td><a name="l197" href="#l197">197</a><td> * Sets the default action to take with an unexpected alert before returning<tr><td><a name="l198" href="#l198">198</a><td> * an error.<tr><td><a name="l199" href="#l199">199</a><td> * @param {string} beahvior The desired behavior; should be &quot;accept&quot;, &quot;dismiss&quot;,<tr><td><a name="l200" href="#l200">200</a><td> * or &quot;ignore&quot;. Defaults to &quot;dismiss&quot;.<tr><td><a name="l201" href="#l201">201</a><td> * @return {!Builder} A self reference.<tr><td><a name="l202" href="#l202">202</a><td> */<tr><td><a name="l203" href="#l203">203</a><td>Builder.prototype.setAlertBehavior = function(behavior) {<tr><td><a name="l204" href="#l204">204</a><td> this.capabilities_.setAlertBehavior(behavior);<tr><td><a name="l205" href="#l205">205</a><td> return this;<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><tr><td><a name="l209" href="#l209">209</a><td>/**<tr><td><a name="l210" href="#l210">210</a><td> * Sets Chrome-specific options for drivers created by this builder. Any<tr><td><a name="l211" href="#l211">211</a><td> * logging or proxy settings defined on the given options will take precedence<tr><td><a name="l212" href="#l212">212</a><td> * over those set through {@link #setLoggingPrefs} and {@link #setProxy},<tr><td><a name="l213" href="#l213">213</a><td> * respectively.<tr><td><a name="l214" href="#l214">214</a><td> *<tr><td><a name="l215" href="#l215">215</a><td> * @param {!chrome.Options} options The ChromeDriver options to use.<tr><td><a name="l216" href="#l216">216</a><td> * @return {!Builder} A self reference.<tr><td><a name="l217" href="#l217">217</a><td> */<tr><td><a name="l218" href="#l218">218</a><td>Builder.prototype.setChromeOptions = function(options) {<tr><td><a name="l219" href="#l219">219</a><td> this.chromeOptions_ = options;<tr><td><a name="l220" href="#l220">220</a><td> return this;<tr><td><a name="l221" href="#l221">221</a><td>};<tr><td><a name="l222" href="#l222">222</a><td><tr><td><a name="l223" href="#l223">223</a><td><tr><td><a name="l224" href="#l224">224</a><td>/**<tr><td><a name="l225" href="#l225">225</a><td> * Sets Firefox-specific options for drivers created by this builder. Any<tr><td><a name="l226" href="#l226">226</a><td> * logging or proxy settings defined on the given options will take precedence<tr><td><a name="l227" href="#l227">227</a><td> * over those set through {@link #setLoggingPrefs} and {@link #setProxy},<tr><td><a name="l228" href="#l228">228</a><td> * respectively.<tr><td><a name="l229" href="#l229">229</a><td> *<tr><td><a name="l230" href="#l230">230</a><td> * @param {!firefox.Options} options The FirefoxDriver options to use.<tr><td><a name="l231" href="#l231">231</a><td> * @return {!Builder} A self reference.<tr><td><a name="l232" href="#l232">232</a><td> */<tr><td><a name="l233" href="#l233">233</a><td>Builder.prototype.setFirefoxOptions = function(options) {<tr><td><a name="l234" href="#l234">234</a><td> this.firefoxOptions_ = options;<tr><td><a name="l235" href="#l235">235</a><td> return this;<tr><td><a name="l236" href="#l236">236</a><td>};<tr><td><a name="l237" href="#l237">237</a><td><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> * Sets the control flow that created drivers should execute actions in. If<tr><td><a name="l241" href="#l241">241</a><td> * the flow is never set, or is set to {@code null}, it will use the active<tr><td><a name="l242" href="#l242">242</a><td> * flow at the time {@link #build()} is called.<tr><td><a name="l243" href="#l243">243</a><td> * @param {webdriver.promise.ControlFlow} flow The control flow to use, or<tr><td><a name="l244" href="#l244">244</a><td> * {@code null} to<tr><td><a name="l245" href="#l245">245</a><td> * @return {!Builder} A self reference.<tr><td><a name="l246" href="#l246">246</a><td> */<tr><td><a name="l247" href="#l247">247</a><td>Builder.prototype.setControlFlow = function(flow) {<tr><td><a name="l248" href="#l248">248</a><td> this.flow_ = flow;<tr><td><a name="l249" href="#l249">249</a><td> return this;<tr><td><a name="l250" href="#l250">250</a><td>};<tr><td><a name="l251" href="#l251">251</a><td><tr><td><a name="l252" href="#l252">252</a><td><tr><td><a name="l253" href="#l253">253</a><td>/**<tr><td><a name="l254" href="#l254">254</a><td> * Creates a new WebDriver client based on this builder&#39;s current<tr><td><a name="l255" href="#l255">255</a><td> * configuration.<tr><td><a name="l256" href="#l256">256</a><td> *<tr><td><a name="l257" href="#l257">257</a><td> * @return {!webdriver.WebDriver} A new WebDriver instance.<tr><td><a name="l258" href="#l258">258</a><td> * @throws {Error} If the current configuration is invalid.<tr><td><a name="l259" href="#l259">259</a><td> */<tr><td><a name="l260" href="#l260">260</a><td>Builder.prototype.build = function() {<tr><td><a name="l261" href="#l261">261</a><td> // Create a copy for any changes we may need to make based on the current<tr><td><a name="l262" href="#l262">262</a><td> // environment.<tr><td><a name="l263" href="#l263">263</a><td> var capabilities = new Capabilities(this.capabilities_);<tr><td><a name="l264" href="#l264">264</a><td><tr><td><a name="l265" href="#l265">265</a><td> var browser = process.env.SELENIUM_BROWSER;<tr><td><a name="l266" href="#l266">266</a><td> if (browser) {<tr><td><a name="l267" href="#l267">267</a><td> browser = browser.split(/:/, 3);<tr><td><a name="l268" href="#l268">268</a><td> capabilities.set(Capability.BROWSER_NAME, browser[0]);<tr><td><a name="l269" href="#l269">269</a><td> capabilities.set(Capability.VERSION, browser[1] || null);<tr><td><a name="l270" href="#l270">270</a><td> capabilities.set(Capability.PLATFORM, browser[2] || null);<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> browser = capabilities.get(Capability.BROWSER_NAME);<tr><td><a name="l274" href="#l274">274</a><td><tr><td><a name="l275" href="#l275">275</a><td> if (!browser) {<tr><td><a name="l276" href="#l276">276</a><td> throw Error(<tr><td><a name="l277" href="#l277">277</a><td> &#39;Target browser not defined; did you forget to call forBrowser()?&#39;);<tr><td><a name="l278" href="#l278">278</a><td> }<tr><td><a name="l279" href="#l279">279</a><td><tr><td><a name="l280" href="#l280">280</a><td> // Apply browser specific overrides.<tr><td><a name="l281" href="#l281">281</a><td> if (browser === Browser.CHROME &amp;&amp; this.chromeOptions_) {<tr><td><a name="l282" href="#l282">282</a><td> capabilities.merge(this.chromeOptions_.toCapabilities());<tr><td><a name="l283" href="#l283">283</a><td> }<tr><td><a name="l284" href="#l284">284</a><td><tr><td><a name="l285" href="#l285">285</a><td> if (browser === Browser.FIREFOX &amp;&amp; this.firefoxOptions_) {<tr><td><a name="l286" href="#l286">286</a><td> capabilities.merge(this.firefoxOptions_.toCapabilities());<tr><td><a name="l287" href="#l287">287</a><td> }<tr><td><a name="l288" href="#l288">288</a><td><tr><td><a name="l289" href="#l289">289</a><td> // Check for a remote browser.<tr><td><a name="l290" href="#l290">290</a><td> var url = process.env.SELENIUM_REMOTE_URL || this.url_;<tr><td><a name="l291" href="#l291">291</a><td> if (url) {<tr><td><a name="l292" href="#l292">292</a><td> var executor = executors.createExecutor(url);<tr><td><a name="l293" href="#l293">293</a><td> return WebDriver.createSession(executor, capabilities, this.flow_);<tr><td><a name="l294" href="#l294">294</a><td> }<tr><td><a name="l295" href="#l295">295</a><td><tr><td><a name="l296" href="#l296">296</a><td> // Check for a native browser.<tr><td><a name="l297" href="#l297">297</a><td> switch (browser) {<tr><td><a name="l298" href="#l298">298</a><td> case Browser.CHROME:<tr><td><a name="l299" href="#l299">299</a><td> // Requiring &#39;chrome&#39; above would create a cycle:<tr><td><a name="l300" href="#l300">300</a><td> // index -&gt; builder -&gt; chrome -&gt; index<tr><td><a name="l301" href="#l301">301</a><td> var chrome = require(&#39;./chrome&#39;);<tr><td><a name="l302" href="#l302">302</a><td> return new chrome.Driver(capabilities, null, this.flow_);<tr><td><a name="l303" href="#l303">303</a><td><tr><td><a name="l304" href="#l304">304</a><td> case Browser.FIREFOX:<tr><td><a name="l305" href="#l305">305</a><td> // Requiring &#39;firefox&#39; above would create a cycle:<tr><td><a name="l306" href="#l306">306</a><td> // index -&gt; builder -&gt; firefox -&gt; index<tr><td><a name="l307" href="#l307">307</a><td> var firefox = require(&#39;./firefox&#39;);<tr><td><a name="l308" href="#l308">308</a><td> return new firefox.Driver(capabilities, this.flow_);<tr><td><a name="l309" href="#l309">309</a><td><tr><td><a name="l310" href="#l310">310</a><td> case Browser.PHANTOM_JS:<tr><td><a name="l311" href="#l311">311</a><td> // Requiring &#39;phantomjs&#39; would create a cycle:<tr><td><a name="l312" href="#l312">312</a><td> // index -&gt; builder -&gt; phantomjs -&gt; index<tr><td><a name="l313" href="#l313">313</a><td> var phantomjs = require(&#39;./phantomjs&#39;);<tr><td><a name="l314" href="#l314">314</a><td> return new phantomjs.Driver(capabilities, this.flow_);<tr><td><a name="l315" href="#l315">315</a><td><tr><td><a name="l316" href="#l316">316</a><td> default:<tr><td><a name="l317" href="#l317">317</a><td> throw new Error(&#39;Do not know how to build driver: &#39; + browser<tr><td><a name="l318" href="#l318">318</a><td> + &#39;; did you forget to call usingServer(url)?&#39;);<tr><td><a name="l319" href="#l319">319</a><td> }<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>// PUBLIC API<tr><td><a name="l324" href="#l324">324</a><td><tr><td><a name="l325" href="#l325">325</a><td><tr><td><a name="l326" href="#l326">326</a><td>exports.Builder = Builder;</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>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</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>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>builder.js</title><link href="../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>builder.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 Software Freedom Conservancy. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>var base = require(&#39;./_base&#39;),<tr><td><a name="l16" href="#l16">16</a><td> executors = require(&#39;./executors&#39;);<tr><td><a name="l17" href="#l17">17</a><td><tr><td><a name="l18" href="#l18">18</a><td>// Use base.require to avoid circular references between index and this module.<tr><td><a name="l19" href="#l19">19</a><td>var Browser = base.require(&#39;webdriver.Browser&#39;),<tr><td><a name="l20" href="#l20">20</a><td> Capabilities = base.require(&#39;webdriver.Capabilities&#39;),<tr><td><a name="l21" href="#l21">21</a><td> Capability = base.require(&#39;webdriver.Capability&#39;),<tr><td><a name="l22" href="#l22">22</a><td> WebDriver = base.require(&#39;webdriver.WebDriver&#39;),<tr><td><a name="l23" href="#l23">23</a><td> promise = base.require(&#39;webdriver.promise&#39;);<tr><td><a name="l24" href="#l24">24</a><td><tr><td><a name="l25" href="#l25">25</a><td><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> * Creates new {@link webdriver.WebDriver WebDriver} instances. The environment<tr><td><a name="l29" href="#l29">29</a><td> * variables listed below may be used to override a builder&#39;s configuration,<tr><td><a name="l30" href="#l30">30</a><td> * allowing quick runtime changes.<tr><td><a name="l31" href="#l31">31</a><td> * &lt;ul&gt;<tr><td><a name="l32" href="#l32">32</a><td> * &lt;li&gt;{@code SELENIUM_REMOTE_URL}: defines the remote URL for all builder<tr><td><a name="l33" href="#l33">33</a><td> * instances. This environment variable should be set to a fully qualified<tr><td><a name="l34" href="#l34">34</a><td> * URL for a WebDriver server (e.g. http://localhost:4444/wd/hub).<tr><td><a name="l35" href="#l35">35</a><td> *<tr><td><a name="l36" href="#l36">36</a><td> * &lt;li&gt;{@code SELENIUM_BROWSER}: defines the target browser in the form<tr><td><a name="l37" href="#l37">37</a><td> * {@code browser[:version][:platform]}.<tr><td><a name="l38" href="#l38">38</a><td> * &lt;/ul&gt;<tr><td><a name="l39" href="#l39">39</a><td> *<tr><td><a name="l40" href="#l40">40</a><td> * &lt;p&gt;Suppose you had mytest.js that created WebDriver with<tr><td><a name="l41" href="#l41">41</a><td> * {@code var driver = new webdriver.Builder().build();}.<tr><td><a name="l42" href="#l42">42</a><td> *<tr><td><a name="l43" href="#l43">43</a><td> * This test could be made to use Firefox on the local machine by running with<tr><td><a name="l44" href="#l44">44</a><td> * {@code SELENIUM_BROWSER=firefox node mytest.js}.<tr><td><a name="l45" href="#l45">45</a><td> *<tr><td><a name="l46" href="#l46">46</a><td> * &lt;p&gt;Alternatively, you could request Chrome 36 on Linux from a remote<tr><td><a name="l47" href="#l47">47</a><td> * server with {@code<tr><td><a name="l48" href="#l48">48</a><td> * SELENIUM_BROWSER=chrome:36:LINUX<tr><td><a name="l49" href="#l49">49</a><td> * SELENIUM_REMOTE_URL=http://www.example.com:4444/wd/hub<tr><td><a name="l50" href="#l50">50</a><td> * node mytest.js}.<tr><td><a name="l51" href="#l51">51</a><td> *<tr><td><a name="l52" href="#l52">52</a><td> * @constructor<tr><td><a name="l53" href="#l53">53</a><td> */<tr><td><a name="l54" href="#l54">54</a><td>var Builder = function() {<tr><td><a name="l55" href="#l55">55</a><td><tr><td><a name="l56" href="#l56">56</a><td> /** @private {webdriver.promise.ControlFlow} */<tr><td><a name="l57" href="#l57">57</a><td> this.flow_ = null;<tr><td><a name="l58" href="#l58">58</a><td><tr><td><a name="l59" href="#l59">59</a><td> /** @private {string} */<tr><td><a name="l60" href="#l60">60</a><td> this.url_ = &#39;&#39;;<tr><td><a name="l61" href="#l61">61</a><td><tr><td><a name="l62" href="#l62">62</a><td> /** @private {!webdriver.Capabilities} */<tr><td><a name="l63" href="#l63">63</a><td> this.capabilities_ = new Capabilities();<tr><td><a name="l64" href="#l64">64</a><td><tr><td><a name="l65" href="#l65">65</a><td> /** @private {chrome.Options} */<tr><td><a name="l66" href="#l66">66</a><td> this.chromeOptions_ = null;<tr><td><a name="l67" href="#l67">67</a><td><tr><td><a name="l68" href="#l68">68</a><td> /** @private {firefox.Options} */<tr><td><a name="l69" href="#l69">69</a><td> this.firefoxOptions_ = null;<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><tr><td><a name="l73" href="#l73">73</a><td>/**<tr><td><a name="l74" href="#l74">74</a><td> * Sets the URL of a remote WebDriver server to use. Once a remote URL has been<tr><td><a name="l75" href="#l75">75</a><td> * specified, the builder direct all new clients to that server. If this method<tr><td><a name="l76" href="#l76">76</a><td> * is never called, the Builder will attempt to create all clients locally.<tr><td><a name="l77" href="#l77">77</a><td> *<tr><td><a name="l78" href="#l78">78</a><td> * &lt;p&gt;As an alternative to this method, you may also set the<tr><td><a name="l79" href="#l79">79</a><td> * {@code SELENIUM_REMOTE_URL} environment variable.<tr><td><a name="l80" href="#l80">80</a><td> *<tr><td><a name="l81" href="#l81">81</a><td> * @param {string} url The URL of a remote server to use.<tr><td><a name="l82" href="#l82">82</a><td> * @return {!Builder} A self reference.<tr><td><a name="l83" href="#l83">83</a><td> */<tr><td><a name="l84" href="#l84">84</a><td>Builder.prototype.usingServer = function(url) {<tr><td><a name="l85" href="#l85">85</a><td> this.url_ = url;<tr><td><a name="l86" href="#l86">86</a><td> return this;<tr><td><a name="l87" href="#l87">87</a><td>};<tr><td><a name="l88" href="#l88">88</a><td><tr><td><a name="l89" href="#l89">89</a><td><tr><td><a name="l90" href="#l90">90</a><td>/**<tr><td><a name="l91" href="#l91">91</a><td> * @return {string} The URL of the WebDriver server this instance is configured<tr><td><a name="l92" href="#l92">92</a><td> * to use.<tr><td><a name="l93" href="#l93">93</a><td> */<tr><td><a name="l94" href="#l94">94</a><td>Builder.prototype.getServerUrl = function() {<tr><td><a name="l95" href="#l95">95</a><td> return this.url_;<tr><td><a name="l96" href="#l96">96</a><td>};<tr><td><a name="l97" href="#l97">97</a><td><tr><td><a name="l98" href="#l98">98</a><td><tr><td><a name="l99" href="#l99">99</a><td>/**<tr><td><a name="l100" href="#l100">100</a><td> * Sets the desired capabilities when requesting a new session. This will<tr><td><a name="l101" href="#l101">101</a><td> * overwrite any previously set capabilities.<tr><td><a name="l102" href="#l102">102</a><td> * @param {!(Object|webdriver.Capabilities)} capabilities The desired<tr><td><a name="l103" href="#l103">103</a><td> * capabilities for a new session.<tr><td><a name="l104" href="#l104">104</a><td> * @return {!Builder} A self reference.<tr><td><a name="l105" href="#l105">105</a><td> */<tr><td><a name="l106" href="#l106">106</a><td>Builder.prototype.withCapabilities = function(capabilities) {<tr><td><a name="l107" href="#l107">107</a><td> this.capabilities_ = new Capabilities(capabilities);<tr><td><a name="l108" href="#l108">108</a><td> return this;<tr><td><a name="l109" href="#l109">109</a><td>};<tr><td><a name="l110" href="#l110">110</a><td><tr><td><a name="l111" href="#l111">111</a><td><tr><td><a name="l112" href="#l112">112</a><td>/**<tr><td><a name="l113" href="#l113">113</a><td> * Returns the base set of capabilities this instance is currently configured<tr><td><a name="l114" href="#l114">114</a><td> * to use.<tr><td><a name="l115" href="#l115">115</a><td> * @return {!webdriver.Capabilities} The current capabilities for this builder.<tr><td><a name="l116" href="#l116">116</a><td> */<tr><td><a name="l117" href="#l117">117</a><td>Builder.prototype.getCapabilities = function() {<tr><td><a name="l118" href="#l118">118</a><td> return this.capabilities_;<tr><td><a name="l119" href="#l119">119</a><td>};<tr><td><a name="l120" href="#l120">120</a><td><tr><td><a name="l121" href="#l121">121</a><td><tr><td><a name="l122" href="#l122">122</a><td>/**<tr><td><a name="l123" href="#l123">123</a><td> * Configures the target browser for clients created by this instance.<tr><td><a name="l124" href="#l124">124</a><td> * Any calls to {@link #withCapabilities} after this function will<tr><td><a name="l125" href="#l125">125</a><td> * overwrite these settings.<tr><td><a name="l126" href="#l126">126</a><td> *<tr><td><a name="l127" href="#l127">127</a><td> * &lt;p&gt;You may also define the target browser using the {@code SELENIUM_BROWSER}<tr><td><a name="l128" href="#l128">128</a><td> * environment variable. If set, this environment variable should be of the<tr><td><a name="l129" href="#l129">129</a><td> * form {@code browser[:[version][:platform]]}.<tr><td><a name="l130" href="#l130">130</a><td> *<tr><td><a name="l131" href="#l131">131</a><td> * @param {(string|webdriver.Browser)} name The name of the target browser;<tr><td><a name="l132" href="#l132">132</a><td> * common defaults are available on the {@link webdriver.Browser} enum.<tr><td><a name="l133" href="#l133">133</a><td> * @param {string=} opt_version A desired version; may be omitted if any<tr><td><a name="l134" href="#l134">134</a><td> * version should be used.<tr><td><a name="l135" href="#l135">135</a><td> * @param {string=} opt_platform The desired platform; may be omitted if any<tr><td><a name="l136" href="#l136">136</a><td> * version may be used.<tr><td><a name="l137" href="#l137">137</a><td> * @return {!Builder} A self reference.<tr><td><a name="l138" href="#l138">138</a><td> */<tr><td><a name="l139" href="#l139">139</a><td>Builder.prototype.forBrowser = function(name, opt_version, opt_platform) {<tr><td><a name="l140" href="#l140">140</a><td> this.capabilities_.set(Capability.BROWSER_NAME, name);<tr><td><a name="l141" href="#l141">141</a><td> this.capabilities_.set(Capability.VERSION, opt_version || null);<tr><td><a name="l142" href="#l142">142</a><td> this.capabilities_.set(Capability.PLATFORM, opt_platform || null);<tr><td><a name="l143" href="#l143">143</a><td> return this;<tr><td><a name="l144" href="#l144">144</a><td>};<tr><td><a name="l145" href="#l145">145</a><td><tr><td><a name="l146" href="#l146">146</a><td><tr><td><a name="l147" href="#l147">147</a><td>/**<tr><td><a name="l148" href="#l148">148</a><td> * Sets the proxy configuration to use for WebDriver clients created by this<tr><td><a name="l149" href="#l149">149</a><td> * builder. Any calls to {@link #withCapabilities} after this function will<tr><td><a name="l150" href="#l150">150</a><td> * overwrite these settings.<tr><td><a name="l151" href="#l151">151</a><td> * @param {!webdriver.ProxyConfig} config The configuration to use.<tr><td><a name="l152" href="#l152">152</a><td> * @return {!Builder} A self reference.<tr><td><a name="l153" href="#l153">153</a><td> */<tr><td><a name="l154" href="#l154">154</a><td>Builder.prototype.setProxy = function(config) {<tr><td><a name="l155" href="#l155">155</a><td> this.capabilities_.setProxy(config);<tr><td><a name="l156" href="#l156">156</a><td> return this;<tr><td><a name="l157" href="#l157">157</a><td>};<tr><td><a name="l158" href="#l158">158</a><td><tr><td><a name="l159" href="#l159">159</a><td><tr><td><a name="l160" href="#l160">160</a><td>/**<tr><td><a name="l161" href="#l161">161</a><td> * Sets the logging preferences for the created session. Preferences may be<tr><td><a name="l162" href="#l162">162</a><td> * changed by repeated calls, or by calling {@link #withCapabilities}.<tr><td><a name="l163" href="#l163">163</a><td> * @param {!(webdriver.logging.Preferences|Object.&lt;string, string&gt;)} prefs The<tr><td><a name="l164" href="#l164">164</a><td> * desired logging preferences.<tr><td><a name="l165" href="#l165">165</a><td> * @return {!Builder} A self reference.<tr><td><a name="l166" href="#l166">166</a><td> */<tr><td><a name="l167" href="#l167">167</a><td>Builder.prototype.setLoggingPrefs = function(prefs) {<tr><td><a name="l168" href="#l168">168</a><td> this.capabilities_.setLoggingPrefs(prefs);<tr><td><a name="l169" href="#l169">169</a><td> return this;<tr><td><a name="l170" href="#l170">170</a><td>};<tr><td><a name="l171" href="#l171">171</a><td><tr><td><a name="l172" href="#l172">172</a><td><tr><td><a name="l173" href="#l173">173</a><td>/**<tr><td><a name="l174" href="#l174">174</a><td> * Sets whether native events should be used.<tr><td><a name="l175" href="#l175">175</a><td> * @param {boolean} enabled Whether to enable native events.<tr><td><a name="l176" href="#l176">176</a><td> * @return {!Builder} A self reference.<tr><td><a name="l177" href="#l177">177</a><td> */<tr><td><a name="l178" href="#l178">178</a><td>Builder.prototype.setEnableNativeEvents = function(enabled) {<tr><td><a name="l179" href="#l179">179</a><td> this.capabilities_.setEnableNativeEvents(enabled);<tr><td><a name="l180" href="#l180">180</a><td> return this;<tr><td><a name="l181" href="#l181">181</a><td>};<tr><td><a name="l182" href="#l182">182</a><td><tr><td><a name="l183" href="#l183">183</a><td><tr><td><a name="l184" href="#l184">184</a><td>/**<tr><td><a name="l185" href="#l185">185</a><td> * Sets how elements should be scrolled into view for interaction.<tr><td><a name="l186" href="#l186">186</a><td> * @param {number} behavior The desired scroll behavior: either 0 to align with<tr><td><a name="l187" href="#l187">187</a><td> * the top of the viewport or 1 to align with the bottom.<tr><td><a name="l188" href="#l188">188</a><td> * @return {!Builder} A self reference.<tr><td><a name="l189" href="#l189">189</a><td> */<tr><td><a name="l190" href="#l190">190</a><td>Builder.prototype.setScrollBehavior = function(behavior) {<tr><td><a name="l191" href="#l191">191</a><td> this.capabilities_.setScrollBehavior(behavior);<tr><td><a name="l192" href="#l192">192</a><td> return this;<tr><td><a name="l193" href="#l193">193</a><td>};<tr><td><a name="l194" href="#l194">194</a><td><tr><td><a name="l195" href="#l195">195</a><td><tr><td><a name="l196" href="#l196">196</a><td>/**<tr><td><a name="l197" href="#l197">197</a><td> * Sets the default action to take with an unexpected alert before returning<tr><td><a name="l198" href="#l198">198</a><td> * an error.<tr><td><a name="l199" href="#l199">199</a><td> * @param {string} beahvior The desired behavior; should be &quot;accept&quot;, &quot;dismiss&quot;,<tr><td><a name="l200" href="#l200">200</a><td> * or &quot;ignore&quot;. Defaults to &quot;dismiss&quot;.<tr><td><a name="l201" href="#l201">201</a><td> * @return {!Builder} A self reference.<tr><td><a name="l202" href="#l202">202</a><td> */<tr><td><a name="l203" href="#l203">203</a><td>Builder.prototype.setAlertBehavior = function(behavior) {<tr><td><a name="l204" href="#l204">204</a><td> this.capabilities_.setAlertBehavior(behavior);<tr><td><a name="l205" href="#l205">205</a><td> return this;<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><tr><td><a name="l209" href="#l209">209</a><td>/**<tr><td><a name="l210" href="#l210">210</a><td> * Sets Chrome-specific options for drivers created by this builder. Any<tr><td><a name="l211" href="#l211">211</a><td> * logging or proxy settings defined on the given options will take precedence<tr><td><a name="l212" href="#l212">212</a><td> * over those set through {@link #setLoggingPrefs} and {@link #setProxy},<tr><td><a name="l213" href="#l213">213</a><td> * respectively.<tr><td><a name="l214" href="#l214">214</a><td> *<tr><td><a name="l215" href="#l215">215</a><td> * @param {!chrome.Options} options The ChromeDriver options to use.<tr><td><a name="l216" href="#l216">216</a><td> * @return {!Builder} A self reference.<tr><td><a name="l217" href="#l217">217</a><td> */<tr><td><a name="l218" href="#l218">218</a><td>Builder.prototype.setChromeOptions = function(options) {<tr><td><a name="l219" href="#l219">219</a><td> this.chromeOptions_ = options;<tr><td><a name="l220" href="#l220">220</a><td> return this;<tr><td><a name="l221" href="#l221">221</a><td>};<tr><td><a name="l222" href="#l222">222</a><td><tr><td><a name="l223" href="#l223">223</a><td><tr><td><a name="l224" href="#l224">224</a><td>/**<tr><td><a name="l225" href="#l225">225</a><td> * Sets Firefox-specific options for drivers created by this builder. Any<tr><td><a name="l226" href="#l226">226</a><td> * logging or proxy settings defined on the given options will take precedence<tr><td><a name="l227" href="#l227">227</a><td> * over those set through {@link #setLoggingPrefs} and {@link #setProxy},<tr><td><a name="l228" href="#l228">228</a><td> * respectively.<tr><td><a name="l229" href="#l229">229</a><td> *<tr><td><a name="l230" href="#l230">230</a><td> * @param {!firefox.Options} options The FirefoxDriver options to use.<tr><td><a name="l231" href="#l231">231</a><td> * @return {!Builder} A self reference.<tr><td><a name="l232" href="#l232">232</a><td> */<tr><td><a name="l233" href="#l233">233</a><td>Builder.prototype.setFirefoxOptions = function(options) {<tr><td><a name="l234" href="#l234">234</a><td> this.firefoxOptions_ = options;<tr><td><a name="l235" href="#l235">235</a><td> return this;<tr><td><a name="l236" href="#l236">236</a><td>};<tr><td><a name="l237" href="#l237">237</a><td><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> * Sets the control flow that created drivers should execute actions in. If<tr><td><a name="l241" href="#l241">241</a><td> * the flow is never set, or is set to {@code null}, it will use the active<tr><td><a name="l242" href="#l242">242</a><td> * flow at the time {@link #build()} is called.<tr><td><a name="l243" href="#l243">243</a><td> * @param {webdriver.promise.ControlFlow} flow The control flow to use, or<tr><td><a name="l244" href="#l244">244</a><td> * {@code null} to<tr><td><a name="l245" href="#l245">245</a><td> * @return {!Builder} A self reference.<tr><td><a name="l246" href="#l246">246</a><td> */<tr><td><a name="l247" href="#l247">247</a><td>Builder.prototype.setControlFlow = function(flow) {<tr><td><a name="l248" href="#l248">248</a><td> this.flow_ = flow;<tr><td><a name="l249" href="#l249">249</a><td> return this;<tr><td><a name="l250" href="#l250">250</a><td>};<tr><td><a name="l251" href="#l251">251</a><td><tr><td><a name="l252" href="#l252">252</a><td><tr><td><a name="l253" href="#l253">253</a><td>/**<tr><td><a name="l254" href="#l254">254</a><td> * Creates a new WebDriver client based on this builder&#39;s current<tr><td><a name="l255" href="#l255">255</a><td> * configuration.<tr><td><a name="l256" href="#l256">256</a><td> *<tr><td><a name="l257" href="#l257">257</a><td> * @return {!webdriver.WebDriver} A new WebDriver instance.<tr><td><a name="l258" href="#l258">258</a><td> * @throws {Error} If the current configuration is invalid.<tr><td><a name="l259" href="#l259">259</a><td> */<tr><td><a name="l260" href="#l260">260</a><td>Builder.prototype.build = function() {<tr><td><a name="l261" href="#l261">261</a><td> // Create a copy for any changes we may need to make based on the current<tr><td><a name="l262" href="#l262">262</a><td> // environment.<tr><td><a name="l263" href="#l263">263</a><td> var capabilities = new Capabilities(this.capabilities_);<tr><td><a name="l264" href="#l264">264</a><td><tr><td><a name="l265" href="#l265">265</a><td> var browser = process.env.SELENIUM_BROWSER;<tr><td><a name="l266" href="#l266">266</a><td> if (browser) {<tr><td><a name="l267" href="#l267">267</a><td> browser = browser.split(/:/, 3);<tr><td><a name="l268" href="#l268">268</a><td> capabilities.set(Capability.BROWSER_NAME, browser[0]);<tr><td><a name="l269" href="#l269">269</a><td> capabilities.set(Capability.VERSION, browser[1] || null);<tr><td><a name="l270" href="#l270">270</a><td> capabilities.set(Capability.PLATFORM, browser[2] || null);<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> browser = capabilities.get(Capability.BROWSER_NAME);<tr><td><a name="l274" href="#l274">274</a><td><tr><td><a name="l275" href="#l275">275</a><td> if (typeof browser !== &#39;string&#39;) {<tr><td><a name="l276" href="#l276">276</a><td> throw TypeError(<tr><td><a name="l277" href="#l277">277</a><td> &#39;Target browser must be a string, but is &lt;&#39; + (typeof browser) + &#39;&gt;;&#39; +<tr><td><a name="l278" href="#l278">278</a><td> &#39; did you forget to call forBrowser()?&#39;);<tr><td><a name="l279" href="#l279">279</a><td> }<tr><td><a name="l280" href="#l280">280</a><td><tr><td><a name="l281" href="#l281">281</a><td> // Apply browser specific overrides.<tr><td><a name="l282" href="#l282">282</a><td> if (browser === Browser.CHROME &amp;&amp; this.chromeOptions_) {<tr><td><a name="l283" href="#l283">283</a><td> capabilities.merge(this.chromeOptions_.toCapabilities());<tr><td><a name="l284" href="#l284">284</a><td> }<tr><td><a name="l285" href="#l285">285</a><td><tr><td><a name="l286" href="#l286">286</a><td> if (browser === Browser.FIREFOX &amp;&amp; this.firefoxOptions_) {<tr><td><a name="l287" href="#l287">287</a><td> capabilities.merge(this.firefoxOptions_.toCapabilities());<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> // Check for a remote browser.<tr><td><a name="l291" href="#l291">291</a><td> var url = process.env.SELENIUM_REMOTE_URL || this.url_;<tr><td><a name="l292" href="#l292">292</a><td> if (url) {<tr><td><a name="l293" href="#l293">293</a><td> var executor = executors.createExecutor(url);<tr><td><a name="l294" href="#l294">294</a><td> return WebDriver.createSession(executor, capabilities, this.flow_);<tr><td><a name="l295" href="#l295">295</a><td> }<tr><td><a name="l296" href="#l296">296</a><td><tr><td><a name="l297" href="#l297">297</a><td> // Check for a native browser.<tr><td><a name="l298" href="#l298">298</a><td> switch (browser) {<tr><td><a name="l299" href="#l299">299</a><td> case Browser.CHROME:<tr><td><a name="l300" href="#l300">300</a><td> // Requiring &#39;chrome&#39; above would create a cycle:<tr><td><a name="l301" href="#l301">301</a><td> // index -&gt; builder -&gt; chrome -&gt; index<tr><td><a name="l302" href="#l302">302</a><td> var chrome = require(&#39;./chrome&#39;);<tr><td><a name="l303" href="#l303">303</a><td> return new chrome.Driver(capabilities, null, this.flow_);<tr><td><a name="l304" href="#l304">304</a><td><tr><td><a name="l305" href="#l305">305</a><td> case Browser.FIREFOX:<tr><td><a name="l306" href="#l306">306</a><td> // Requiring &#39;firefox&#39; above would create a cycle:<tr><td><a name="l307" href="#l307">307</a><td> // index -&gt; builder -&gt; firefox -&gt; index<tr><td><a name="l308" href="#l308">308</a><td> var firefox = require(&#39;./firefox&#39;);<tr><td><a name="l309" href="#l309">309</a><td> return new firefox.Driver(capabilities, this.flow_);<tr><td><a name="l310" href="#l310">310</a><td><tr><td><a name="l311" href="#l311">311</a><td> case Browser.PHANTOM_JS:<tr><td><a name="l312" href="#l312">312</a><td> // Requiring &#39;phantomjs&#39; would create a cycle:<tr><td><a name="l313" href="#l313">313</a><td> // index -&gt; builder -&gt; phantomjs -&gt; index<tr><td><a name="l314" href="#l314">314</a><td> var phantomjs = require(&#39;./phantomjs&#39;);<tr><td><a name="l315" href="#l315">315</a><td> return new phantomjs.Driver(capabilities, this.flow_);<tr><td><a name="l316" href="#l316">316</a><td><tr><td><a name="l317" href="#l317">317</a><td> default:<tr><td><a name="l318" href="#l318">318</a><td> throw new Error(&#39;Do not know how to build driver: &#39; + browser<tr><td><a name="l319" href="#l319">319</a><td> + &#39;; did you forget to call usingServer(url)?&#39;);<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>// PUBLIC API<tr><td><a name="l325" href="#l325">325</a><td><tr><td><a name="l326" href="#l326">326</a><td><tr><td><a name="l327" href="#l327">327</a><td>exports.Builder = Builder;</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>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</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>