selenium-webdriver 2.48.2 → 2.52.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 (524) hide show
  1. package/CHANGES.md +57 -0
  2. package/NOTICE +1 -1
  3. package/README.md +56 -6
  4. package/builder.js +375 -358
  5. package/chrome.js +549 -586
  6. package/edge.js +378 -0
  7. package/error.js +597 -5
  8. package/example/google_search_generator.js +2 -4
  9. package/example/logging.js +6 -2
  10. package/executors.js +11 -27
  11. package/firefox/binary.js +79 -87
  12. package/firefox/extension.js +10 -18
  13. package/firefox/index.js +173 -173
  14. package/firefox/profile.js +220 -240
  15. package/http/index.js +396 -79
  16. package/http/util.js +35 -35
  17. package/ie.js +288 -309
  18. package/index.js +34 -125
  19. package/io/exec.js +58 -39
  20. package/io/index.js +54 -48
  21. package/lib/actions.js +594 -0
  22. package/lib/by.js +276 -0
  23. package/lib/capabilities.js +404 -0
  24. package/lib/{webdriver/command.js → command.js} +88 -72
  25. package/lib/{webdriver/button.js → devmode.js} +13 -8
  26. package/lib/events.js +210 -0
  27. package/lib/firefox/amd64/libnoblur64.so +0 -0
  28. package/lib/firefox/i386/libnoblur.so +0 -0
  29. package/lib/firefox/webdriver.json +5 -1
  30. package/lib/firefox/webdriver.xpi +0 -0
  31. package/lib/{webdriver/key.js → input.js} +82 -2
  32. package/lib/logging.js +668 -0
  33. package/lib/{webdriver/promise.js → promise.js} +688 -644
  34. package/lib/session.js +79 -0
  35. package/lib/{webdriver/serializable.js → symbols.js} +11 -16
  36. package/lib/test/build.js +4 -4
  37. package/lib/test/data/click_tests/html5_submit_buttons.html +2 -1
  38. package/lib/test/data/click_tests/overlapping_elements.html +15 -4
  39. package/lib/test/data/click_tests/partially_overlapping_elements.html +124 -0
  40. package/lib/test/data/click_tests/wrapped_overlapping_elements.html +13 -0
  41. package/lib/test/data/readOnlyPage.html +1 -1
  42. package/lib/test/data/selectPage.html +18 -2
  43. package/lib/test/fileserver.js +3 -4
  44. package/lib/test/index.js +7 -3
  45. package/lib/test/resources.js +1 -1
  46. package/lib/until.js +428 -0
  47. package/lib/webdriver.js +2351 -0
  48. package/net/portprober.js +15 -11
  49. package/opera.js +295 -314
  50. package/package.json +6 -5
  51. package/phantomjs.js +135 -140
  52. package/proxy.js +6 -4
  53. package/remote/index.js +229 -221
  54. package/safari.js +319 -310
  55. package/test/chrome/options_test.js +11 -9
  56. package/test/element_finding_test.js +51 -13
  57. package/test/error_test.js +163 -0
  58. package/test/execute_script_test.js +1 -1
  59. package/test/http/http_test.js +317 -55
  60. package/test/http/util_test.js +25 -23
  61. package/test/io_test.js +6 -1
  62. package/test/lib/by_test.js +127 -0
  63. package/test/lib/capabilities_test.js +84 -0
  64. package/test/lib/events_test.js +177 -0
  65. package/test/lib/logging_test.js +272 -0
  66. package/test/{promise_aplus_test.js → lib/promise_aplus_test.js} +4 -13
  67. package/test/lib/promise_error_test.js +808 -0
  68. package/test/lib/promise_flow_test.js +2282 -0
  69. package/test/lib/promise_generator_test.js +308 -0
  70. package/test/lib/promise_test.js +996 -0
  71. package/test/lib/testutil.js +90 -0
  72. package/test/lib/until_test.js +436 -0
  73. package/test/lib/webdriver_test.js +2207 -0
  74. package/test/page_loading_test.js +7 -9
  75. package/test/stale_element_test.js +2 -2
  76. package/test/testing/assert_test.js +374 -0
  77. package/test/testing/index_test.js +9 -11
  78. package/testing/assert.js +334 -17
  79. package/testing/index.js +10 -0
  80. package/_base.js +0 -200
  81. package/docs/Changes.html +0 -356
  82. package/docs/class_bot_Error.html +0 -15
  83. package/docs/class_webdriver_ActionSequence.html +0 -115
  84. package/docs/class_webdriver_Alert.html +0 -24
  85. package/docs/class_webdriver_AlertPromise.html +0 -92
  86. package/docs/class_webdriver_Capabilities.html +0 -60
  87. package/docs/class_webdriver_Command.html +0 -15
  88. package/docs/class_webdriver_EventEmitter.html +0 -35
  89. package/docs/class_webdriver_FileDetector.html +0 -21
  90. package/docs/class_webdriver_Locator.html +0 -12
  91. package/docs/class_webdriver_Serializable.html +0 -9
  92. package/docs/class_webdriver_Session.html +0 -13
  93. package/docs/class_webdriver_TouchSequence.html +0 -49
  94. package/docs/class_webdriver_UnhandledAlertError.html +0 -18
  95. package/docs/class_webdriver_WebDriver.html +0 -313
  96. package/docs/class_webdriver_WebDriver_Logs.html +0 -15
  97. package/docs/class_webdriver_WebDriver_Navigation.html +0 -16
  98. package/docs/class_webdriver_WebDriver_Options.html +0 -41
  99. package/docs/class_webdriver_WebDriver_TargetLocator.html +0 -38
  100. package/docs/class_webdriver_WebDriver_Timeouts.html +0 -29
  101. package/docs/class_webdriver_WebDriver_Window.html +0 -27
  102. package/docs/class_webdriver_WebElement.html +0 -223
  103. package/docs/class_webdriver_WebElementPromise.html +0 -274
  104. package/docs/class_webdriver_http_Executor.html +0 -22
  105. package/docs/class_webdriver_http_Request.html +0 -12
  106. package/docs/class_webdriver_http_Response.html +0 -13
  107. package/docs/class_webdriver_logging_Entry.html +0 -15
  108. package/docs/class_webdriver_logging_Level.html +0 -55
  109. package/docs/class_webdriver_logging_LogRecord.html +0 -45
  110. package/docs/class_webdriver_logging_Logger.html +0 -119
  111. package/docs/class_webdriver_logging_Preferences.html +0 -8
  112. package/docs/class_webdriver_promise_CancellationError.html +0 -17
  113. package/docs/class_webdriver_promise_ControlFlow.html +0 -153
  114. package/docs/class_webdriver_promise_Deferred.html +0 -84
  115. package/docs/class_webdriver_promise_MultipleUnhandledRejectionError.html +0 -14
  116. package/docs/class_webdriver_promise_Promise.html +0 -75
  117. package/docs/class_webdriver_stacktrace_Frame.html +0 -20
  118. package/docs/class_webdriver_stacktrace_Snapshot.html +0 -6
  119. package/docs/class_webdriver_testing_Assertion.html +0 -99
  120. package/docs/class_webdriver_testing_Assertion_DelegatingMatcher_.html +0 -13
  121. package/docs/class_webdriver_testing_ContainsMatcher.html +0 -11
  122. package/docs/class_webdriver_testing_NegatedAssertion.html +0 -97
  123. package/docs/class_webdriver_until_Condition.html +0 -7
  124. package/docs/dossier.css +0 -1
  125. package/docs/dossier.js +0 -86
  126. package/docs/enum_bot_ErrorCode.html +0 -3
  127. package/docs/enum_bot_Error_State.html +0 -2
  128. package/docs/enum_webdriver_Browser.html +0 -2
  129. package/docs/enum_webdriver_Button.html +0 -2
  130. package/docs/enum_webdriver_Capability.html +0 -33
  131. package/docs/enum_webdriver_CommandName.html +0 -3
  132. package/docs/enum_webdriver_Key.html +0 -12
  133. package/docs/enum_webdriver_logging_Type.html +0 -6
  134. package/docs/enum_webdriver_promise_ControlFlow_EventType.html +0 -9
  135. package/docs/index.html +0 -125
  136. package/docs/interface_webdriver_CommandExecutor.html +0 -9
  137. package/docs/interface_webdriver_http_Client.html +0 -10
  138. package/docs/interface_webdriver_promise_Thenable.html +0 -77
  139. package/docs/module_selenium-webdriver.html +0 -23
  140. package/docs/module_selenium-webdriver__base.html +0 -23
  141. package/docs/module_selenium-webdriver__base_class_Context.html +0 -5
  142. package/docs/module_selenium-webdriver_builder.html +0 -2
  143. package/docs/module_selenium-webdriver_builder_class_Builder.html +0 -138
  144. package/docs/module_selenium-webdriver_chrome.html +0 -90
  145. package/docs/module_selenium-webdriver_chrome_class_Driver.html +0 -280
  146. package/docs/module_selenium-webdriver_chrome_class_Options.html +0 -127
  147. package/docs/module_selenium-webdriver_chrome_class_ServiceBuilder.html +0 -46
  148. package/docs/module_selenium-webdriver_class_ActionSequence.html +0 -115
  149. package/docs/module_selenium-webdriver_class_Builder.html +0 -138
  150. package/docs/module_selenium-webdriver_class_Capabilities.html +0 -60
  151. package/docs/module_selenium-webdriver_class_Command.html +0 -15
  152. package/docs/module_selenium-webdriver_class_EventEmitter.html +0 -35
  153. package/docs/module_selenium-webdriver_class_FileDetector.html +0 -21
  154. package/docs/module_selenium-webdriver_class_Serializable.html +0 -9
  155. package/docs/module_selenium-webdriver_class_Session.html +0 -13
  156. package/docs/module_selenium-webdriver_class_WebDriver.html +0 -313
  157. package/docs/module_selenium-webdriver_class_WebElement.html +0 -223
  158. package/docs/module_selenium-webdriver_class_WebElementPromise.html +0 -274
  159. package/docs/module_selenium-webdriver_enum_Browser.html +0 -2
  160. package/docs/module_selenium-webdriver_enum_Button.html +0 -2
  161. package/docs/module_selenium-webdriver_enum_Capability.html +0 -33
  162. package/docs/module_selenium-webdriver_enum_CommandName.html +0 -3
  163. package/docs/module_selenium-webdriver_enum_Key.html +0 -12
  164. package/docs/module_selenium-webdriver_error.html +0 -4
  165. package/docs/module_selenium-webdriver_error_class_Error.html +0 -15
  166. package/docs/module_selenium-webdriver_error_enum_ErrorCode.html +0 -3
  167. package/docs/module_selenium-webdriver_executors.html +0 -10
  168. package/docs/module_selenium-webdriver_executors_class_DeferredExecutor.html +0 -12
  169. package/docs/module_selenium-webdriver_firefox.html +0 -68
  170. package/docs/module_selenium-webdriver_firefox_binary.html +0 -5
  171. package/docs/module_selenium-webdriver_firefox_binary_class_Binary.html +0 -20
  172. package/docs/module_selenium-webdriver_firefox_class_Binary.html +0 -20
  173. package/docs/module_selenium-webdriver_firefox_class_Driver.html +0 -276
  174. package/docs/module_selenium-webdriver_firefox_class_Options.html +0 -19
  175. package/docs/module_selenium-webdriver_firefox_class_Profile.html +0 -50
  176. package/docs/module_selenium-webdriver_firefox_extension.html +0 -8
  177. package/docs/module_selenium-webdriver_firefox_profile.html +0 -13
  178. package/docs/module_selenium-webdriver_firefox_profile_class_Profile.html +0 -50
  179. package/docs/module_selenium-webdriver_http.html +0 -9
  180. package/docs/module_selenium-webdriver_http_class_Executor.html +0 -22
  181. package/docs/module_selenium-webdriver_http_class_HttpClient.html +0 -16
  182. package/docs/module_selenium-webdriver_http_class_Request.html +0 -12
  183. package/docs/module_selenium-webdriver_http_class_Response.html +0 -13
  184. package/docs/module_selenium-webdriver_http_util.html +0 -17
  185. package/docs/module_selenium-webdriver_ie.html +0 -11
  186. package/docs/module_selenium-webdriver_ie_class_Driver.html +0 -274
  187. package/docs/module_selenium-webdriver_ie_class_Options.html +0 -89
  188. package/docs/module_selenium-webdriver_ie_enum_Level.html +0 -1
  189. package/docs/module_selenium-webdriver_io.html +0 -37
  190. package/docs/module_selenium-webdriver_io_exec.html +0 -6
  191. package/docs/module_selenium-webdriver_namespace_By.html +0 -56
  192. package/docs/module_selenium-webdriver_namespace_error.html +0 -4
  193. package/docs/module_selenium-webdriver_namespace_logging.html +0 -18
  194. package/docs/module_selenium-webdriver_namespace_promise.html +0 -163
  195. package/docs/module_selenium-webdriver_namespace_stacktrace.html +0 -17
  196. package/docs/module_selenium-webdriver_namespace_until.html +0 -82
  197. package/docs/module_selenium-webdriver_net.html +0 -7
  198. package/docs/module_selenium-webdriver_net_portprober.html +0 -12
  199. package/docs/module_selenium-webdriver_opera.html +0 -62
  200. package/docs/module_selenium-webdriver_opera_class_Driver.html +0 -276
  201. package/docs/module_selenium-webdriver_opera_class_Options.html +0 -44
  202. package/docs/module_selenium-webdriver_opera_class_ServiceBuilder.html +0 -35
  203. package/docs/module_selenium-webdriver_phantomjs.html +0 -2
  204. package/docs/module_selenium-webdriver_phantomjs_class_Driver.html +0 -299
  205. package/docs/module_selenium-webdriver_proxy.html +0 -28
  206. package/docs/module_selenium-webdriver_remote.html +0 -8
  207. package/docs/module_selenium-webdriver_remote_class_DriverService.html +0 -32
  208. package/docs/module_selenium-webdriver_remote_class_FileDetector.html +0 -22
  209. package/docs/module_selenium-webdriver_remote_class_SeleniumServer.html +0 -41
  210. package/docs/module_selenium-webdriver_safari.html +0 -9
  211. package/docs/module_selenium-webdriver_safari_class_Driver.html +0 -279
  212. package/docs/module_selenium-webdriver_safari_class_Options.html +0 -23
  213. package/docs/module_selenium-webdriver_testing.html +0 -74
  214. package/docs/module_selenium-webdriver_testing_assert.html +0 -9
  215. package/docs/namespace_bot.html +0 -4
  216. package/docs/namespace_bot_json.html +0 -20
  217. package/docs/namespace_bot_response.html +0 -18
  218. package/docs/namespace_bot_userAgent.html +0 -33
  219. package/docs/namespace_webdriver.html +0 -30
  220. package/docs/namespace_webdriver_By.html +0 -56
  221. package/docs/namespace_webdriver_http.html +0 -6
  222. package/docs/namespace_webdriver_logging.html +0 -70
  223. package/docs/namespace_webdriver_promise.html +0 -688
  224. package/docs/namespace_webdriver_stacktrace.html +0 -17
  225. package/docs/namespace_webdriver_testing.html +0 -7
  226. package/docs/namespace_webdriver_testing_assert.html +0 -9
  227. package/docs/namespace_webdriver_testing_asserts.html +0 -18
  228. package/docs/namespace_webdriver_until.html +0 -82
  229. package/docs/source/_base.js.src.html +0 -1
  230. package/docs/source/builder.js.src.html +0 -1
  231. package/docs/source/chrome.js.src.html +0 -1
  232. package/docs/source/error.js.src.html +0 -1
  233. package/docs/source/executors.js.src.html +0 -1
  234. package/docs/source/firefox/binary.js.src.html +0 -1
  235. package/docs/source/firefox/extension.js.src.html +0 -1
  236. package/docs/source/firefox/index.js.src.html +0 -1
  237. package/docs/source/firefox/profile.js.src.html +0 -1
  238. package/docs/source/http/index.js.src.html +0 -1
  239. package/docs/source/http/util.js.src.html +0 -1
  240. package/docs/source/ie.js.src.html +0 -1
  241. package/docs/source/index.js.src.html +0 -1
  242. package/docs/source/io/exec.js.src.html +0 -1
  243. package/docs/source/io/index.js.src.html +0 -1
  244. package/docs/source/lib/atoms/error.js.src.html +0 -1
  245. package/docs/source/lib/atoms/json.js.src.html +0 -1
  246. package/docs/source/lib/atoms/response.js.src.html +0 -1
  247. package/docs/source/lib/atoms/userAgent.js.src.html +0 -1
  248. package/docs/source/lib/goog/array/array.js.src.html +0 -1
  249. package/docs/source/lib/goog/asserts/asserts.js.src.html +0 -1
  250. package/docs/source/lib/goog/async/freelist.js.src.html +0 -1
  251. package/docs/source/lib/goog/async/nexttick.js.src.html +0 -1
  252. package/docs/source/lib/goog/async/run.js.src.html +0 -1
  253. package/docs/source/lib/goog/async/workqueue.js.src.html +0 -1
  254. package/docs/source/lib/goog/base.js.src.html +0 -1
  255. package/docs/source/lib/goog/debug/debug.js.src.html +0 -1
  256. package/docs/source/lib/goog/debug/entrypointregistry.js.src.html +0 -1
  257. package/docs/source/lib/goog/debug/error.js.src.html +0 -1
  258. package/docs/source/lib/goog/debug/logbuffer.js.src.html +0 -1
  259. package/docs/source/lib/goog/debug/logger.js.src.html +0 -1
  260. package/docs/source/lib/goog/debug/logrecord.js.src.html +0 -1
  261. package/docs/source/lib/goog/deps.js.src.html +0 -1
  262. package/docs/source/lib/goog/disposable/disposable.js.src.html +0 -1
  263. package/docs/source/lib/goog/disposable/idisposable.js.src.html +0 -1
  264. package/docs/source/lib/goog/dom/browserfeature.js.src.html +0 -1
  265. package/docs/source/lib/goog/dom/dom.js.src.html +0 -1
  266. package/docs/source/lib/goog/dom/nodetype.js.src.html +0 -1
  267. package/docs/source/lib/goog/dom/safe.js.src.html +0 -1
  268. package/docs/source/lib/goog/dom/tagname.js.src.html +0 -1
  269. package/docs/source/lib/goog/dom/tags.js.src.html +0 -1
  270. package/docs/source/lib/goog/dom/vendor.js.src.html +0 -1
  271. package/docs/source/lib/goog/events/browserevent.js.src.html +0 -1
  272. package/docs/source/lib/goog/events/browserfeature.js.src.html +0 -1
  273. package/docs/source/lib/goog/events/event.js.src.html +0 -1
  274. package/docs/source/lib/goog/events/eventid.js.src.html +0 -1
  275. package/docs/source/lib/goog/events/events.js.src.html +0 -1
  276. package/docs/source/lib/goog/events/eventtarget.js.src.html +0 -1
  277. package/docs/source/lib/goog/events/eventtype.js.src.html +0 -1
  278. package/docs/source/lib/goog/events/keycodes.js.src.html +0 -1
  279. package/docs/source/lib/goog/events/listenable.js.src.html +0 -1
  280. package/docs/source/lib/goog/events/listener.js.src.html +0 -1
  281. package/docs/source/lib/goog/events/listenermap.js.src.html +0 -1
  282. package/docs/source/lib/goog/fs/url.js.src.html +0 -1
  283. package/docs/source/lib/goog/functions/functions.js.src.html +0 -1
  284. package/docs/source/lib/goog/html/safehtml.js.src.html +0 -1
  285. package/docs/source/lib/goog/html/safescript.js.src.html +0 -1
  286. package/docs/source/lib/goog/html/safestyle.js.src.html +0 -1
  287. package/docs/source/lib/goog/html/safestylesheet.js.src.html +0 -1
  288. package/docs/source/lib/goog/html/safeurl.js.src.html +0 -1
  289. package/docs/source/lib/goog/html/trustedresourceurl.js.src.html +0 -1
  290. package/docs/source/lib/goog/html/uncheckedconversions.js.src.html +0 -1
  291. package/docs/source/lib/goog/i18n/bidi.js.src.html +0 -1
  292. package/docs/source/lib/goog/iter/iter.js.src.html +0 -1
  293. package/docs/source/lib/goog/json/json.js.src.html +0 -1
  294. package/docs/source/lib/goog/labs/testing/assertthat.js.src.html +0 -1
  295. package/docs/source/lib/goog/labs/testing/logicmatcher.js.src.html +0 -1
  296. package/docs/source/lib/goog/labs/testing/matcher.js.src.html +0 -1
  297. package/docs/source/lib/goog/labs/testing/numbermatcher.js.src.html +0 -1
  298. package/docs/source/lib/goog/labs/testing/objectmatcher.js.src.html +0 -1
  299. package/docs/source/lib/goog/labs/testing/stringmatcher.js.src.html +0 -1
  300. package/docs/source/lib/goog/labs/useragent/browser.js.src.html +0 -1
  301. package/docs/source/lib/goog/labs/useragent/engine.js.src.html +0 -1
  302. package/docs/source/lib/goog/labs/useragent/platform.js.src.html +0 -1
  303. package/docs/source/lib/goog/labs/useragent/util.js.src.html +0 -1
  304. package/docs/source/lib/goog/log/log.js.src.html +0 -1
  305. package/docs/source/lib/goog/math/box.js.src.html +0 -1
  306. package/docs/source/lib/goog/math/coordinate.js.src.html +0 -1
  307. package/docs/source/lib/goog/math/math.js.src.html +0 -1
  308. package/docs/source/lib/goog/math/rect.js.src.html +0 -1
  309. package/docs/source/lib/goog/math/size.js.src.html +0 -1
  310. package/docs/source/lib/goog/net/wrapperxmlhttpfactory.js.src.html +0 -1
  311. package/docs/source/lib/goog/net/xhrlike.js.src.html +0 -1
  312. package/docs/source/lib/goog/net/xmlhttp.js.src.html +0 -1
  313. package/docs/source/lib/goog/net/xmlhttpfactory.js.src.html +0 -1
  314. package/docs/source/lib/goog/object/object.js.src.html +0 -1
  315. package/docs/source/lib/goog/promise/promise.js.src.html +0 -1
  316. package/docs/source/lib/goog/promise/resolver.js.src.html +0 -1
  317. package/docs/source/lib/goog/promise/thenable.js.src.html +0 -1
  318. package/docs/source/lib/goog/reflect/reflect.js.src.html +0 -1
  319. package/docs/source/lib/goog/string/const.js.src.html +0 -1
  320. package/docs/source/lib/goog/string/string.js.src.html +0 -1
  321. package/docs/source/lib/goog/string/typedstring.js.src.html +0 -1
  322. package/docs/source/lib/goog/structs/collection.js.src.html +0 -1
  323. package/docs/source/lib/goog/structs/map.js.src.html +0 -1
  324. package/docs/source/lib/goog/structs/set.js.src.html +0 -1
  325. package/docs/source/lib/goog/structs/structs.js.src.html +0 -1
  326. package/docs/source/lib/goog/style/style.js.src.html +0 -1
  327. package/docs/source/lib/goog/testing/asserts.js.src.html +0 -1
  328. package/docs/source/lib/goog/testing/events/events.js.src.html +0 -1
  329. package/docs/source/lib/goog/testing/functionmock.js.src.html +0 -1
  330. package/docs/source/lib/goog/testing/jsunit.js.src.html +0 -1
  331. package/docs/source/lib/goog/testing/loosemock.js.src.html +0 -1
  332. package/docs/source/lib/goog/testing/mock.js.src.html +0 -1
  333. package/docs/source/lib/goog/testing/mockclock.js.src.html +0 -1
  334. package/docs/source/lib/goog/testing/mockcontrol.js.src.html +0 -1
  335. package/docs/source/lib/goog/testing/mockinterface.js.src.html +0 -1
  336. package/docs/source/lib/goog/testing/mockmatchers.js.src.html +0 -1
  337. package/docs/source/lib/goog/testing/objectpropertystring.js.src.html +0 -1
  338. package/docs/source/lib/goog/testing/propertyreplacer.js.src.html +0 -1
  339. package/docs/source/lib/goog/testing/recordfunction.js.src.html +0 -1
  340. package/docs/source/lib/goog/testing/stacktrace.js.src.html +0 -1
  341. package/docs/source/lib/goog/testing/strictmock.js.src.html +0 -1
  342. package/docs/source/lib/goog/testing/testcase.js.src.html +0 -1
  343. package/docs/source/lib/goog/testing/testrunner.js.src.html +0 -1
  344. package/docs/source/lib/goog/uri/uri.js.src.html +0 -1
  345. package/docs/source/lib/goog/uri/utils.js.src.html +0 -1
  346. package/docs/source/lib/goog/useragent/product.js.src.html +0 -1
  347. package/docs/source/lib/goog/useragent/product_isversion.js.src.html +0 -1
  348. package/docs/source/lib/goog/useragent/useragent.js.src.html +0 -1
  349. package/docs/source/lib/webdriver/actionsequence.js.src.html +0 -1
  350. package/docs/source/lib/webdriver/button.js.src.html +0 -1
  351. package/docs/source/lib/webdriver/capabilities.js.src.html +0 -1
  352. package/docs/source/lib/webdriver/command.js.src.html +0 -1
  353. package/docs/source/lib/webdriver/events.js.src.html +0 -1
  354. package/docs/source/lib/webdriver/http/http.js.src.html +0 -1
  355. package/docs/source/lib/webdriver/key.js.src.html +0 -1
  356. package/docs/source/lib/webdriver/locators.js.src.html +0 -1
  357. package/docs/source/lib/webdriver/logging.js.src.html +0 -1
  358. package/docs/source/lib/webdriver/promise.js.src.html +0 -1
  359. package/docs/source/lib/webdriver/serializable.js.src.html +0 -1
  360. package/docs/source/lib/webdriver/session.js.src.html +0 -1
  361. package/docs/source/lib/webdriver/stacktrace.js.src.html +0 -1
  362. package/docs/source/lib/webdriver/testing/asserts.js.src.html +0 -1
  363. package/docs/source/lib/webdriver/touchsequence.js.src.html +0 -1
  364. package/docs/source/lib/webdriver/until.js.src.html +0 -1
  365. package/docs/source/lib/webdriver/webdriver.js.src.html +0 -1
  366. package/docs/source/net/index.js.src.html +0 -1
  367. package/docs/source/net/portprober.js.src.html +0 -1
  368. package/docs/source/opera.js.src.html +0 -1
  369. package/docs/source/phantomjs.js.src.html +0 -1
  370. package/docs/source/proxy.js.src.html +0 -1
  371. package/docs/source/remote/index.js.src.html +0 -1
  372. package/docs/source/safari.js.src.html +0 -1
  373. package/docs/source/testing/assert.js.src.html +0 -1
  374. package/docs/source/testing/index.js.src.html +0 -1
  375. package/docs/types.js +0 -1
  376. package/lib/atoms/error.js +0 -202
  377. package/lib/atoms/json.js +0 -80
  378. package/lib/atoms/response.js +0 -110
  379. package/lib/atoms/userAgent.js +0 -257
  380. package/lib/goog/LICENSE +0 -176
  381. package/lib/goog/array/array.js +0 -1654
  382. package/lib/goog/asserts/asserts.js +0 -365
  383. package/lib/goog/async/freelist.js +0 -88
  384. package/lib/goog/async/nexttick.js +0 -241
  385. package/lib/goog/async/run.js +0 -133
  386. package/lib/goog/async/workqueue.js +0 -139
  387. package/lib/goog/base.js +0 -2548
  388. package/lib/goog/debug/debug.js +0 -653
  389. package/lib/goog/debug/entrypointregistry.js +0 -158
  390. package/lib/goog/debug/error.js +0 -63
  391. package/lib/goog/debug/logbuffer.js +0 -148
  392. package/lib/goog/debug/logger.js +0 -873
  393. package/lib/goog/debug/logrecord.js +0 -242
  394. package/lib/goog/deps.js +0 -151
  395. package/lib/goog/disposable/disposable.js +0 -307
  396. package/lib/goog/disposable/idisposable.js +0 -45
  397. package/lib/goog/dom/browserfeature.js +0 -72
  398. package/lib/goog/dom/dom.js +0 -2991
  399. package/lib/goog/dom/nodetype.js +0 -48
  400. package/lib/goog/dom/safe.js +0 -347
  401. package/lib/goog/dom/tagname.js +0 -160
  402. package/lib/goog/dom/tags.js +0 -41
  403. package/lib/goog/dom/vendor.js +0 -96
  404. package/lib/goog/events/browserevent.js +0 -400
  405. package/lib/goog/events/browserfeature.js +0 -85
  406. package/lib/goog/events/event.js +0 -143
  407. package/lib/goog/events/eventid.js +0 -47
  408. package/lib/goog/events/events.js +0 -984
  409. package/lib/goog/events/eventtarget.js +0 -394
  410. package/lib/goog/events/eventtype.js +0 -237
  411. package/lib/goog/events/keycodes.js +0 -427
  412. package/lib/goog/events/listenable.js +0 -335
  413. package/lib/goog/events/listener.js +0 -131
  414. package/lib/goog/events/listenermap.js +0 -308
  415. package/lib/goog/fs/url.js +0 -109
  416. package/lib/goog/functions/functions.js +0 -442
  417. package/lib/goog/html/safehtml.js +0 -757
  418. package/lib/goog/html/safescript.js +0 -234
  419. package/lib/goog/html/safestyle.js +0 -442
  420. package/lib/goog/html/safestylesheet.js +0 -276
  421. package/lib/goog/html/safeurl.js +0 -398
  422. package/lib/goog/html/trustedresourceurl.js +0 -224
  423. package/lib/goog/html/uncheckedconversions.js +0 -232
  424. package/lib/goog/i18n/bidi.js +0 -908
  425. package/lib/goog/iter/iter.js +0 -1302
  426. package/lib/goog/json/json.js +0 -363
  427. package/lib/goog/labs/testing/assertthat.js +0 -58
  428. package/lib/goog/labs/testing/logicmatcher.js +0 -212
  429. package/lib/goog/labs/testing/matcher.js +0 -80
  430. package/lib/goog/labs/testing/numbermatcher.js +0 -346
  431. package/lib/goog/labs/testing/objectmatcher.js +0 -317
  432. package/lib/goog/labs/testing/stringmatcher.js +0 -415
  433. package/lib/goog/labs/useragent/browser.js +0 -341
  434. package/lib/goog/labs/useragent/engine.js +0 -160
  435. package/lib/goog/labs/useragent/platform.js +0 -160
  436. package/lib/goog/labs/useragent/util.js +0 -148
  437. package/lib/goog/log/log.js +0 -197
  438. package/lib/goog/math/box.js +0 -398
  439. package/lib/goog/math/coordinate.js +0 -268
  440. package/lib/goog/math/math.js +0 -451
  441. package/lib/goog/math/rect.js +0 -476
  442. package/lib/goog/math/size.js +0 -227
  443. package/lib/goog/net/wrapperxmlhttpfactory.js +0 -71
  444. package/lib/goog/net/xhrlike.js +0 -124
  445. package/lib/goog/net/xmlhttp.js +0 -246
  446. package/lib/goog/net/xmlhttpfactory.js +0 -67
  447. package/lib/goog/object/object.js +0 -686
  448. package/lib/goog/promise/promise.js +0 -1350
  449. package/lib/goog/promise/resolver.js +0 -48
  450. package/lib/goog/promise/thenable.js +0 -126
  451. package/lib/goog/reflect/reflect.js +0 -77
  452. package/lib/goog/string/const.js +0 -182
  453. package/lib/goog/string/string.js +0 -1599
  454. package/lib/goog/string/typedstring.js +0 -48
  455. package/lib/goog/structs/collection.js +0 -56
  456. package/lib/goog/structs/map.js +0 -457
  457. package/lib/goog/structs/set.js +0 -279
  458. package/lib/goog/structs/structs.js +0 -354
  459. package/lib/goog/style/style.js +0 -2037
  460. package/lib/goog/testing/asserts.js +0 -1278
  461. package/lib/goog/testing/events/events.js +0 -767
  462. package/lib/goog/testing/functionmock.js +0 -175
  463. package/lib/goog/testing/jsunit.js +0 -162
  464. package/lib/goog/testing/loosemock.js +0 -242
  465. package/lib/goog/testing/mock.js +0 -645
  466. package/lib/goog/testing/mockclock.js +0 -606
  467. package/lib/goog/testing/mockcontrol.js +0 -220
  468. package/lib/goog/testing/mockinterface.js +0 -45
  469. package/lib/goog/testing/mockmatchers.js +0 -400
  470. package/lib/goog/testing/objectpropertystring.js +0 -68
  471. package/lib/goog/testing/propertyreplacer.js +0 -262
  472. package/lib/goog/testing/recordfunction.js +0 -215
  473. package/lib/goog/testing/stacktrace.js +0 -594
  474. package/lib/goog/testing/strictmock.js +0 -130
  475. package/lib/goog/testing/testcase.js +0 -1629
  476. package/lib/goog/testing/testrunner.js +0 -440
  477. package/lib/goog/uri/uri.js +0 -1524
  478. package/lib/goog/uri/utils.js +0 -1064
  479. package/lib/goog/useragent/product.js +0 -183
  480. package/lib/goog/useragent/product_isversion.js +0 -144
  481. package/lib/goog/useragent/useragent.js +0 -572
  482. package/lib/webdriver/actionsequence.js +0 -356
  483. package/lib/webdriver/builder.js +0 -207
  484. package/lib/webdriver/capabilities.js +0 -412
  485. package/lib/webdriver/events.js +0 -179
  486. package/lib/webdriver/firefoxdomexecutor.js +0 -175
  487. package/lib/webdriver/http/corsclient.js +0 -133
  488. package/lib/webdriver/http/http.js +0 -525
  489. package/lib/webdriver/http/xhrclient.js +0 -67
  490. package/lib/webdriver/locators.js +0 -257
  491. package/lib/webdriver/logging.js +0 -347
  492. package/lib/webdriver/session.js +0 -74
  493. package/lib/webdriver/stacktrace.js +0 -619
  494. package/lib/webdriver/test/builder_test.js +0 -53
  495. package/lib/webdriver/test/capabilities_test.js +0 -72
  496. package/lib/webdriver/test/events_test.js +0 -203
  497. package/lib/webdriver/test/http/corsclient_test.js +0 -151
  498. package/lib/webdriver/test/http/http_test.js +0 -428
  499. package/lib/webdriver/test/http/xhrclient_test.js +0 -196
  500. package/lib/webdriver/test/locators_test.js +0 -59
  501. package/lib/webdriver/test/logging_test.js +0 -85
  502. package/lib/webdriver/test/promise_error_test.js +0 -892
  503. package/lib/webdriver/test/promise_flow_test.js +0 -2365
  504. package/lib/webdriver/test/promise_generator_test.js +0 -323
  505. package/lib/webdriver/test/promise_test.js +0 -2012
  506. package/lib/webdriver/test/stacktrace_test.js +0 -480
  507. package/lib/webdriver/test/test_bootstrap.js +0 -67
  508. package/lib/webdriver/test/testing/asserts_test.js +0 -117
  509. package/lib/webdriver/test/testing/client_test.js +0 -88
  510. package/lib/webdriver/test/testing/testcase_test.js +0 -229
  511. package/lib/webdriver/test/testutil.js +0 -209
  512. package/lib/webdriver/test/testutil_test.js +0 -104
  513. package/lib/webdriver/test/until_test.js +0 -411
  514. package/lib/webdriver/test/webdriver_generator_test.js +0 -92
  515. package/lib/webdriver/test/webdriver_test.js +0 -2369
  516. package/lib/webdriver/testing/asserts.js +0 -487
  517. package/lib/webdriver/testing/client.js +0 -179
  518. package/lib/webdriver/testing/jsunit.js +0 -363
  519. package/lib/webdriver/testing/testcase.js +0 -168
  520. package/lib/webdriver/testing/window.js +0 -244
  521. package/lib/webdriver/touchsequence.js +0 -248
  522. package/lib/webdriver/until.js +0 -412
  523. package/lib/webdriver/webdriver.js +0 -2511
  524. package/test/_base_test.js +0 -129
@@ -1,299 +0,0 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>Driver</title><link href="dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article><div class="parentlink"><b>Module:</b> <a href="module_selenium-webdriver_phantomjs.html">selenium-webdriver/phantomjs</a></div><div class="codelink"><a href="source/phantomjs.js.src.html#l265">View Source</a></div><h1>class Driver</h1><pre class="inheritance"><a href="class_webdriver_WebDriver.html">webdriver.WebDriver</a>
2
- &#x2514; Driver</pre><p>Creates a new WebDriver client for PhantomJS.</p>
3
- <h3>new Driver(<wbr>opt_capabilities, opt_flow)</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_capabilities<code>?<a href="module_selenium-webdriver_class_Capabilities.html">Capabilities</a>=</code><dd><p>The desired capabilities.</p>
4
- <dt>opt_flow<code>?<a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a>=</code><dd><p>The control flow to use, or
5
- <code>null</code> to use the currently active flow.</p>
6
- </dl></div></div><h2>Instance Methods</h2><div id="actions" class="function"><div><h3>actions()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l469">code »</a></span></h3><p>Creates a new action sequence using this driver. The sequence will not be
7
- scheduled for execution until <a href="class_webdriver_ActionSequence.html#perform"><code>webdriver.ActionSequence#perform</code></a> is
8
- called. Example:</p>
9
- <pre><code>driver.actions().
10
- mouseDown(element1).
11
- mouseMove(element2).
12
- mouseUp().
13
- perform();
14
- </code></pre>
15
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#actions">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_ActionSequence.html">webdriver.ActionSequence</a></code><dd><p>A new action sequence for this instance.</p>
16
- </dl></div></div></div></div><hr class="fn-sep"><div id="call" class="function"><div><h3><code>&lt;T&gt;</code> call(<wbr>fn, opt_scope, var_args)<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l639">code »</a></span></h3><p>Schedules a command to execute a custom function.</p>
17
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#call">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>fn<code>function(...?): (T|<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;T&gt;)</code><dd><p>The function to
18
- execute.</p>
19
- <dt>opt_scope<code>?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>=</code><dd><p>The object in whose scope to execute the function.</p>
20
- <dt>var_args<code>...*</code><dd><p>Any arguments to pass to the function.</p>
21
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;T&gt;</code><dd><p>A promise that will be resolved&#39;
22
- with the function&#39;s result.</p>
23
- </dl></div></div></div></div><hr class="fn-sep"><div id="close" class="function"><div><h3>close()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l780">code »</a></span></h3><p>Schedules a command to close the current window.</p>
24
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#close">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>&gt;</code><dd><p>A promise that will be resolved
25
- when this command has completed.</p>
26
- </dl></div></div></div></div><hr class="fn-sep"><div id="controlFlow" class="function"><div><h3>controlFlow()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l324">code »</a></span></h3><p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#controlFlow">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a></code><dd><p>The control flow used by this
27
- instance.</p>
28
- </dl></div></div></div></div><hr class="fn-sep"><div id="executeAsyncScript" class="function"><div><h3><code>&lt;T&gt;</code> executeAsyncScript(<wbr>script, var_args)<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l617">code »</a></span></h3><p>Schedules a command to execute asynchronous JavaScript in the context of the
29
- currently selected frame or window. The script fragment will be executed as
30
- the body of an anonymous function. If the script is provided as a function
31
- object, that function will be converted to a string for injection into the
32
- target window.</p>
33
- <p>Any arguments provided in addition to the script will be included as script
34
- arguments and may be referenced using the <code>arguments</code> object.
35
- Arguments may be a boolean, number, string, or <code>webdriver.WebElement</code>.
36
- Arrays and objects may also be used as script arguments as long as each item
37
- adheres to the types previously mentioned.</p>
38
- <p>Unlike executing synchronous JavaScript with <a href="module_selenium-webdriver_phantomjs_class_Driver.html#executeScript"><code>#executeScript</code></a>,
39
- scripts executed with this function must explicitly signal they are finished
40
- by invoking the provided callback. This callback will always be injected
41
- into the executed function as the last argument, and thus may be referenced
42
- with <code>arguments[arguments.length - 1]</code>. The following steps will be
43
- taken for resolving this functions return value against the first argument
44
- to the script&#39;s callback function:</p>
45
- <ul><li>For a HTML element, the value will resolve to a
46
- <a href="class_webdriver_WebElement.html"><code>webdriver.WebElement</code></a></li><li>Null and undefined return values will resolve to null</li><li>Booleans, numbers, and strings will resolve as is</li><li>Functions will resolve to their string representation</li><li>For arrays and objects, each member item will be converted according to
47
- the rules above</li></ul>
48
- <p><strong>Example #1:</strong> Performing a sleep that is synchronized with the currently
49
- selected window:</p>
50
- <pre><code>var start &#61; new Date().getTime();
51
- driver.executeAsyncScript(
52
- &#39;window.setTimeout(arguments[arguments.length - 1], 500);&#39;).
53
- then(function() {
54
- console.log(
55
- &#39;Elapsed time: &#39; &#43; (new Date().getTime() - start) &#43; &#39; ms&#39;);
56
- });
57
- </code></pre>
58
- <p><strong>Example #2:</strong> Synchronizing a test with an AJAX application:</p>
59
- <pre><code>var button &#61; driver.findElement(By.id(&#39;compose-button&#39;));
60
- button.click();
61
- driver.executeAsyncScript(
62
- &#39;var callback &#61; arguments[arguments.length - 1];&#39; &#43;
63
- &#39;mailClient.getComposeWindowWidget().onload(callback);&#39;);
64
- driver.switchTo().frame(&#39;composeWidget&#39;);
65
- driver.findElement(By.id(&#39;to&#39;)).sendKeys(&#39;dog&#64;example.com&#39;);
66
- </code></pre>
67
- <p><strong>Example #3:</strong> Injecting a XMLHttpRequest and waiting for the result. In
68
- this example, the inject script is specified with a function literal. When
69
- using this format, the function is converted to a string for injection, so it
70
- should not reference any symbols not defined in the scope of the page under
71
- test.</p>
72
- <pre><code>driver.executeAsyncScript(function() {
73
- var callback &#61; arguments[arguments.length - 1];
74
- var xhr &#61; new XMLHttpRequest();
75
- xhr.open(&#34;GET&#34;, &#34;/resource/data.json&#34;, true);
76
- xhr.onreadystatechange &#61; function() {
77
- if (xhr.readyState &#61;&#61; 4) {
78
- callback(xhr.responseText);
79
- }
80
- };
81
- xhr.send(&#39;&#39;);
82
- }).then(function(str) {
83
- console.log(JSON.parse(str)[&#39;food&#39;]);
84
- });
85
- </code></pre>
86
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#executeAsyncScript">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>script<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|Function)</code><dd><p>The script to execute.</p>
87
- <dt>var_args<code>...*</code><dd><p>The arguments to pass to the script.</p>
88
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;T&gt;</code><dd><p>A promise that will resolve to the
89
- scripts return value.</p>
90
- </dl></div></div></div></div><hr class="fn-sep"><div id="executePhantomJS" class="function"><div><h3><code>&lt;T&gt;</code> executePhantomJS(<wbr>script, var_args)<span class="codelink"><a href="source/phantomjs.js.src.html#l249">code »</a></span></h3><p>Executes a PhantomJS fragment. This method is similar to
91
- <a href="module_selenium-webdriver_phantomjs_class_Driver.html#executeScript"><code>#executeScript</code></a>, except it exposes the
92
- <a href="http://phantomjs.org/api/">PhantomJS API</a> to the injected
93
- script.</p>
94
- <p>The injected script will execute in the context of PhantomJS&#39;s
95
- <code>page</code> variable. If a page has not been loaded before calling this
96
- method, one will be created.</p>
97
- <p>Be sure to wrap callback definitions in a try/catch block, as failures
98
- may cause future WebDriver calls to fail.</p>
99
- <p>Certain callbacks are used by GhostDriver (the PhantomJS WebDriver
100
- implementation) and overriding these may cause the script to fail. It is
101
- recommended that you check for existing callbacks before defining your own.
102
- </p>
103
- <p>As with <a href="module_selenium-webdriver_phantomjs_class_Driver.html#executeScript"><code>#executeScript</code></a>, the injected script may be defined as
104
- a string for an anonymous function body (e.g. &#34;return 123;&#34;), or as a
105
- function. If a function is provided, it will be decompiled to its original
106
- source. Note that injecting functions is provided as a convenience to
107
- simplify defining complex scripts. Care must be taken that the function
108
- only references variables that will be defined in the page&#39;s scope and
109
- that the function does not override <code>Function.prototype.toString</code>
110
- (overriding toString() will interfere with how the function is
111
- decompiled.</p>
112
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>script<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|Function)</code><dd><p>The script to execute.</p>
113
- <dt>var_args<code>...*</code><dd><p>The arguments to pass to the script.</p>
114
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code><dd><p>A promise that resolve to the
115
- script&#39;s return value.</p>
116
- </dl></div></div></div></div><hr class="fn-sep"><div id="executeScript" class="function"><div><h3><code>&lt;T&gt;</code> executeScript(<wbr>script, var_args)<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l528">code »</a></span></h3><p>Schedules a command to execute JavaScript in the context of the currently
117
- selected frame or window. The script fragment will be executed as the body
118
- of an anonymous function. If the script is provided as a function object,
119
- that function will be converted to a string for injection into the target
120
- window.</p>
121
- <p>Any arguments provided in addition to the script will be included as script
122
- arguments and may be referenced using the <code>arguments</code> object.
123
- Arguments may be a boolean, number, string, or <code>webdriver.WebElement</code>.
124
- Arrays and objects may also be used as script arguments as long as each item
125
- adheres to the types previously mentioned.</p>
126
- <p>The script may refer to any variables accessible from the current window.
127
- Furthermore, the script will execute in the window&#39;s context, thus
128
- <code>document</code> may be used to refer to the current document. Any local
129
- variables will not be available once the script has finished executing,
130
- though global variables will persist.</p>
131
- <p>If the script has a return value (i.e. if the script contains a return
132
- statement), then the following steps will be taken for resolving this
133
- functions return value:</p>
134
- <ul><li>For a HTML element, the value will resolve to a
135
- <a href="class_webdriver_WebElement.html"><code>webdriver.WebElement</code></a></li><li>Null and undefined return values will resolve to null</li><li>Booleans, numbers, and strings will resolve as is</li><li>Functions will resolve to their string representation</li><li>For arrays and objects, each member item will be converted according to
136
- the rules above</li></ul>
137
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#executeScript">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>script<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|Function)</code><dd><p>The script to execute.</p>
138
- <dt>var_args<code>...*</code><dd><p>The arguments to pass to the script.</p>
139
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;T&gt;</code><dd><p>A promise that will resolve to the
140
- scripts return value.</p>
141
- </dl></div></div></div></div><hr class="fn-sep"><div id="findElement" class="function"><div><h3>findElement(<wbr>locator)<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l867">code »</a></span></h3><p>Schedule a command to find an element on the page. If the element cannot be
142
- found, a <a href="enum_bot_ErrorCode.html#NO_SUCH_ELEMENT"><code>bot.ErrorCode.NO_SUCH_ELEMENT</code></a> result will be returned
143
- by the driver. Unlike other commands, this error cannot be suppressed. In
144
- other words, scheduling a command to find an element doubles as an assert
145
- that the element is present on the page. To test whether an element is
146
- present on the page, use <a href="module_selenium-webdriver_phantomjs_class_Driver.html#isElementPresent"><code>#isElementPresent</code></a> instead.</p>
147
- <p>The search criteria for an element may be defined using one of the
148
- factories in the <a href="namespace_webdriver_By.html"><code>webdriver.By</code></a> namespace, or as a short-hand
149
- <a href="namespace_webdriver_By.html#By.Hash"><code>webdriver.By.Hash</code></a> object. For example, the following two statements
150
- are equivalent:</p>
151
- <pre><code>var e1 &#61; driver.findElement(By.id(&#39;foo&#39;));
152
- var e2 &#61; driver.findElement({id:&#39;foo&#39;});
153
- </code></pre>
154
- <p>You may also provide a custom locator function, which takes as input
155
- this WebDriver instance and returns a <a href="class_webdriver_WebElement.html"><code>webdriver.WebElement</code></a>, or a
156
- promise that will resolve to a WebElement. For example, to find the first
157
- visible link on a page, you could write:</p>
158
- <pre><code>var link &#61; driver.findElement(firstVisibleLink);
159
-
160
- function firstVisibleLink(driver) {
161
- var links &#61; driver.findElements(By.tagName(&#39;a&#39;));
162
- return webdriver.promise.filter(links, function(link) {
163
- return links.isDisplayed();
164
- }).then(function(visibleLinks) {
165
- return visibleLinks[0];
166
- });
167
- }
168
- </code></pre>
169
- <p>When running in the browser, a WebDriver cannot manipulate DOM elements
170
- directly; it may do so only through a <a href="class_webdriver_WebElement.html"><code>webdriver.WebElement</code></a> reference.
171
- This function may be used to generate a WebElement from a DOM element. A
172
- reference to the DOM element will be stored in a known location and this
173
- driver will attempt to retrieve it through <a href="module_selenium-webdriver_phantomjs_class_Driver.html#executeScript"><code>#executeScript</code></a>. If the
174
- element cannot be found (eg, it belongs to a different document than the
175
- one this instance is currently focused on), a
176
- <a href="enum_bot_ErrorCode.html#NO_SUCH_ELEMENT"><code>bot.ErrorCode.NO_SUCH_ELEMENT</code></a> error will be returned.</p>
177
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#findElement">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>locator<code>(<a href="class_webdriver_Locator.html">webdriver.Locator</a>|{className: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{css: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{id: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{js: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{linkText: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{name: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{partialLinkText: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{tagName: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{xpath: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>})</code><dd><p>The
178
- locator to use.</p>
179
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_WebElement.html">webdriver.WebElement</a></code><dd><p>A WebElement that can be used to issue
180
- commands against the located element. If the element is not found, the
181
- element will be invalidated and all scheduled commands aborted.</p>
182
- </dl></div></div></div></div><hr class="fn-sep"><div id="findElements" class="function"><div><h3>findElements(<wbr>locator)<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l994">code »</a></span></h3><p>Schedule a command to search for multiple elements on the page.</p>
183
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#findElements">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>locator<code>(<a href="class_webdriver_Locator.html">webdriver.Locator</a>|{className: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{css: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{id: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{js: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{linkText: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{name: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{partialLinkText: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{tagName: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{xpath: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>})</code><dd><p>The locator
184
- strategy to use when searching for the element.</p>
185
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="class_webdriver_WebElement.html">webdriver.WebElement</a>&gt;&gt;</code><dd><p>A
186
- promise that will resolve to an array of WebElements.</p>
187
- </dl></div></div></div></div><hr class="fn-sep"><div id="get" class="function"><div><h3>get(<wbr>url)<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l792">code »</a></span></h3><p>Schedules a command to navigate to the given URL.</p>
188
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#get">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>url<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The fully qualified URL to open.</p>
189
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>&gt;</code><dd><p>A promise that will be resolved
190
- when the document has finished loading.</p>
191
- </dl></div></div></div></div><hr class="fn-sep"><div id="getAllWindowHandles" class="function"><div><h3>getAllWindowHandles()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l753">code »</a></span></h3><p>Schedules a command to retrieve the current list of available window handles.</p>
192
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#getAllWindowHandles">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;&gt;</code><dd><p>A promise that will
193
- be resolved with an array of window handles.</p>
194
- </dl></div></div></div></div><hr class="fn-sep"><div id="getCapabilities" class="function"><div><h3>getCapabilities()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l430">code »</a></span></h3><p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#getCapabilities">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a>&gt;</code><dd><p>A promise
195
- that will resolve with the this instance&#39;s capabilities.</p>
196
- </dl></div></div></div></div><hr class="fn-sep"><div id="getCurrentUrl" class="function"><div><h3>getCurrentUrl()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l802">code »</a></span></h3><p>Schedules a command to retrieve the URL of the current page.</p>
197
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#getCurrentUrl">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</code><dd><p>A promise that will be
198
- resolved with the current URL.</p>
199
- </dl></div></div></div></div><hr class="fn-sep"><div id="getPageSource" class="function"><div><h3>getPageSource()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l768">code »</a></span></h3><p>Schedules a command to retrieve the current page&#39;s source. The page source
200
- returned is a representation of the underlying DOM: do not expect it to be
201
- formatted or escaped in the same way as the response sent from the web
202
- server.</p>
203
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#getPageSource">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</code><dd><p>A promise that will be
204
- resolved with the current page source.</p>
205
- </dl></div></div></div></div><hr class="fn-sep"><div id="getSession" class="function"><div><h3>getSession()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l421">code »</a></span></h3><p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#getSession">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="class_webdriver_Session.html">webdriver.Session</a>&gt;</code><dd><p>A promise for this
206
- client&#39;s session.</p>
207
- </dl></div></div></div></div><hr class="fn-sep"><div id="getTitle" class="function"><div><h3>getTitle()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l814">code »</a></span></h3><p>Schedules a command to retrieve the current page&#39;s title.</p>
208
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#getTitle">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</code><dd><p>A promise that will be
209
- resolved with the current page&#39;s title.</p>
210
- </dl></div></div></div></div><hr class="fn-sep"><div id="getWindowHandle" class="function"><div><h3>getWindowHandle()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l741">code »</a></span></h3><p>Schedules a command to retrieve they current window handle.</p>
211
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#getWindowHandle">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</code><dd><p>A promise that will be
212
- resolved with the current window handle.</p>
213
- </dl></div></div></div></div><hr class="fn-sep"><div id="isElementPresent" class="function"><div><h3>isElementPresent(<wbr>locatorOrElement)<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l974">code »</a></span></h3><p>Schedules a command to test if an element is present on the page.</p>
214
- <p>If given a DOM element, this function will check if it belongs to the
215
- document the driver is currently focused on. Otherwise, the function will
216
- test if at least one element can be found with the given search criteria.</p>
217
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#isElementPresent">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>locatorOrElement<code>(<a href="class_webdriver_Locator.html">webdriver.Locator</a>|{className: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{css: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{id: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{js: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{linkText: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{name: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{partialLinkText: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{tagName: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}|{xpath: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>})</code><dd><p>The locator to use, or the actual
218
- DOM element to be located by the server.</p>
219
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>&gt;</code><dd><p>A promise that will resolve
220
- with whether the element is present on the page.</p>
221
- </dl></div></div></div></div><hr class="fn-sep"><div id="manage" class="function"><div><h3>manage()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l1056">code »</a></span></h3><p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#manage">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_WebDriver_Options.html">webdriver.WebDriver.Options</a></code><dd><p>The options interface for this
222
- instance.</p>
223
- </dl></div></div></div></div><hr class="fn-sep"><div id="navigate" class="function"><div><h3>navigate()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l1065">code »</a></span></h3><p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#navigate">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_WebDriver_Navigation.html">webdriver.WebDriver.Navigation</a></code><dd><p>The navigation interface for this
224
- instance.</p>
225
- </dl></div></div></div></div><hr class="fn-sep"><div id="quit" class="function"><div><h3>quit()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l444">code »</a></span></h3><p>Schedules a command to quit the current session. After calling quit, this
226
- instance will be invalidated and may no longer be used to issue commands
227
- against the browser.</p>
228
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#quit">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>&gt;</code><dd><p>A promise that will be resolved
229
- when the command has completed.</p>
230
- </dl></div></div></div></div><hr class="fn-sep"><div id="schedule" class="function"><div><h3><code>&lt;T&gt;</code> schedule(<wbr>command, description)<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l338">code »</a></span></h3><p>Schedules a <code>webdriver.Command</code> to be executed by this driver&#39;s
231
- <code>webdriver.CommandExecutor</code>.</p>
232
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#schedule">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>command<code><a href="class_webdriver_Command.html">webdriver.Command</a></code><dd><p>The command to schedule.</p>
233
- <dt>description<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>A description of the command for debugging.</p>
234
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;T&gt;</code><dd><p>A promise that will be resolved
235
- with the command result.</p>
236
- </dl></div></div></div></div><hr class="fn-sep"><div id="setFileDetector" class="function"><div><h3>setFileDetector(<wbr>detector)<span class="codelink"><a href="source/phantomjs.js.src.html#l211">code »</a></span></h3><p>This function is a no-op as file detectors are not supported by this
237
- implementation.</p>
238
- <p><b>Overrides: </b><a href="class_webdriver_WebDriver.html#setFileDetector">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>detector<code><a href="class_webdriver_FileDetector.html">webdriver.FileDetector</a></code><dd><p>The detector to use or <code>null</code>.</p>
239
- </dl></div></div></div></div><hr class="fn-sep"><div id="sleep" class="function"><div><h3>sleep(<wbr>ms)<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l731">code »</a></span></h3><p>Schedules a command to make the driver sleep for the given amount of time.</p>
240
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#sleep">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>ms<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd><p>The amount of time, in milliseconds, to sleep.</p>
241
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>&gt;</code><dd><p>A promise that will be resolved
242
- when the sleep has finished.</p>
243
- </dl></div></div></div></div><hr class="fn-sep"><div id="switchTo" class="function"><div><h3>switchTo()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l1074">code »</a></span></h3><p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#switchTo">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_WebDriver_TargetLocator.html">webdriver.WebDriver.TargetLocator</a></code><dd><p>The target locator interface for
244
- this instance.</p>
245
- </dl></div></div></div></div><hr class="fn-sep"><div id="takeScreenshot" class="function"><div><h3>takeScreenshot()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l1046">code »</a></span></h3><p>Schedule a command to take a screenshot. The driver makes a best effort to
246
- return a screenshot of the following, in order of preference:</p>
247
- <ol><li>Entire page
248
- </li><li>Current window
249
- </li><li>Visible portion of the current frame
250
- </li><li>The screenshot of the entire display containing the browser
251
- </li></ol>
252
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#takeScreenshot">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</code><dd><p>A promise that will be
253
- resolved to the screenshot as a base-64 encoded PNG.</p>
254
- </dl></div></div></div></div><hr class="fn-sep"><div id="touchActions" class="function"><div><h3>touchActions()<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l486">code »</a></span></h3><p>Creates a new touch sequence using this driver. The sequence will not be
255
- scheduled for execution until <a href="class_webdriver_TouchSequence.html#perform"><code>webdriver.TouchSequence#perform</code></a> is
256
- called. Example:</p>
257
- <pre><code>driver.touchActions().
258
- tap(element1).
259
- doubleTap(element2).
260
- perform();
261
- </code></pre>
262
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#touchActions">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_TouchSequence.html">webdriver.TouchSequence</a></code><dd><p>A new touch sequence for this instance.</p>
263
- </dl></div></div></div></div><hr class="fn-sep"><div id="wait" class="function"><div><h3><code>&lt;T&gt;</code> wait(<wbr>condition, opt_timeout, opt_message)<span class="codelink"><a href="source/lib/webdriver/webdriver.js.src.html#l700">code »</a></span></h3><p>Schedules a command to wait for a condition to hold. The condition may be
264
- specified by a <a href="class_webdriver_until_Condition.html"><code>webdriver.until.Condition</code></a>, as a custom function, or
265
- as a <a href="class_webdriver_promise_Promise.html"><code>webdriver.promise.Promise</code></a>.</p>
266
- <p>For a <a href="class_webdriver_until_Condition.html"><code>webdriver.until.Condition</code></a> or function, the wait will repeatedly
267
- evaluate the condition until it returns a truthy value. If any errors occur
268
- while evaluating the condition, they will be allowed to propagate. In the
269
- event a condition returns a <a href="class_webdriver_promise_Promise.html"><code>promise</code></a>, the
270
- polling loop will wait for it to be resolved and use the resolved value for
271
- whether the condition has been satisified. Note the resolution time for
272
- a promise is factored into whether a wait has timed out.</p>
273
- <p><em>Example:</em> waiting up to 10 seconds for an element to be present and visible
274
- on the page.</p>
275
- <pre><code>var button &#61; driver.wait(until.elementLocated(By.id(&#39;foo&#39;)), 10000);
276
- button.click();
277
- </code></pre>
278
- <p>This function may also be used to block the command flow on the resolution
279
- of a <a href="class_webdriver_promise_Promise.html"><code>promise</code></a>. When given a promise, the
280
- command will simply wait for its resolution before completing. A timeout may
281
- be provided to fail the command if the promise does not resolve before the
282
- timeout expires.</p>
283
- <p><em>Example:</em> Suppose you have a function, <code>startTestServer</code>, that returns a
284
- promise for when a server is ready for requests. You can block a <code>WebDriver</code>
285
- client on this promise with:</p>
286
- <pre><code>var started &#61; startTestServer();
287
- driver.wait(started, 5 * 1000, &#39;Server should start within 5 seconds&#39;);
288
- driver.get(getServerUrl());
289
- </code></pre>
290
- <p><b>Defined by: </b><a href="class_webdriver_WebDriver.html#wait">webdriver.WebDriver</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>condition<code>(<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;T&gt;|<a href="class_webdriver_until_Condition.html">webdriver.until.Condition</a>&lt;T&gt;|function(<a href="class_webdriver_WebDriver.html">webdriver.WebDriver</a>): T)</code><dd><p>The condition to
291
- wait on, defined as a promise, condition object, or a function to
292
- evaluate as a condition.</p>
293
- <dt>opt_timeout<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>=</code><dd><p>How long to wait for the condition to be true.</p>
294
- <dt>opt_message<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>=</code><dd><p>An optional message to use if the wait times
295
- out.</p>
296
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;T&gt;</code><dd><p>A promise that will be fulfilled
297
- with the first truthy value returned by the condition function, or
298
- rejected if the condition times out.</p>
299
- </dl></div></div></div></div></article><nav><h3><a href="index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="types.js"></script><script src="dossier.js"></script>
@@ -1,28 +0,0 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>selenium-webdriver/proxy</title><link href="dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article><div class="codelink"><a href="source/proxy.js.src.html#l30">View Source</a></div><h1>module selenium-webdriver/proxy</h1><p>Defines functions for configuring a webdriver proxy:</p>
2
- <pre><code>var webdriver &#61; require(&#39;selenium-webdriver&#39;),
3
- proxy &#61; require(&#39;selenium-webdriver/proxy&#39;);
4
-
5
- var driver &#61; new webdriver.Builder()
6
- .withCapabilities(webdriver.Capabilities.chrome())
7
- .setProxy(proxy.manual({http: &#39;host:1234&#39;}))
8
- .build();
9
- </code></pre>
10
- <h2>Functions</h2><div id="direct" class="function"><div><h3>direct()<span class="codelink"><a href="source/proxy.js.src.html#l43">code »</a></span></h3><p>Configures WebDriver to bypass all browser proxies.</p>
11
- <div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code>{proxyType: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}</code><dd><p>A new proxy configuration object.</p>
12
- </dl></div></div></div></div><hr class="fn-sep"><div id="manual" class="function"><div><h3>manual(<wbr>options)<span class="codelink"><a href="source/proxy.js.src.html#l69">code »</a></span></h3><p>Manually configures the browser proxy. The following options are
13
- supported:</p>
14
- <ul><li><code>ftp</code>: Proxy host to use for FTP requests</li><li><code>http</code>: Proxy host to use for HTTP requests</li><li><code>https</code>: Proxy host to use for HTTPS requests</li><li><code>bypass</code>: A list of hosts requests should directly connect to,
15
- bypassing any other proxies for that request. May be specified as a
16
- comma separated string, or a list of strings.</li></ul>
17
- <p>Behavior is undefined for FTP, HTTP, and HTTPS requests if the
18
- corresponding key is omitted from the configuration options.</p>
19
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>options<code>{bypass: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), ftp: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), http: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), https: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>)}</code><dd><p>Proxy
20
- configuration options.</p>
21
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code>{proxyType: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}</code><dd><p>A new proxy configuration object.</p>
22
- </dl></div></div></div></div><hr class="fn-sep"><div id="pac" class="function"><div><h3>pac(<wbr>url)<span class="codelink"><a href="source/proxy.js.src.html#l87">code »</a></span></h3><p>Configures WebDriver to configure the browser proxy using the PAC file at
23
- the given URL.</p>
24
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>url<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>URL for the PAC proxy to use.</p>
25
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code>{proxyType: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}</code><dd><p>A new proxy configuration object.</p>
26
- </dl></div></div></div></div><hr class="fn-sep"><div id="system" class="function"><div><h3>system()<span class="codelink"><a href="source/proxy.js.src.html#l99">code »</a></span></h3><p>Configures WebDriver to use the current system&#39;s proxy.</p>
27
- <div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code>{proxyType: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}</code><dd><p>A new proxy configuration object.</p>
28
- </dl></div></div></div></div></article><nav><h3><a href="index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="types.js"></script><script src="dossier.js"></script>
@@ -1,8 +0,0 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>selenium-webdriver/remote</title><link href="dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article><div class="codelink"><a href="source/remote/index.js.src.html#l18">View Source</a></div><h1>module selenium-webdriver/remote</h1><h2>Types</h2><dl><dt><a href="module_selenium-webdriver_remote_class_DriverService.html">DriverService</a><dd><p>Manages the life and death of a native executable WebDriver server.</p>
2
- <dt><a href="module_selenium-webdriver_remote_class_FileDetector.html">FileDetector</a><dd><p>A <a href="class_webdriver_FileDetector.html"><code>webdriver.FileDetector</code></a> that may be used when running
3
- against a remote
4
- <a href="http://selenium-release.storage.googleapis.com/index.html">Selenium server</a>.</p>
5
- <dt><a href="module_selenium-webdriver_remote_class_SeleniumServer.html">SeleniumServer</a><dd><p>Manages the life and death of the
6
- <a href="http://selenium-release.storage.googleapis.com/index.html">
7
- standalone Selenium server</a>.</p>
8
- </dl></article><nav><h3><a href="index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="types.js"></script><script src="dossier.js"></script>
@@ -1,32 +0,0 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>DriverService</title><link href="dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article><div class="parentlink"><b>Module:</b> <a href="module_selenium-webdriver_remote.html">selenium-webdriver/remote</a></div><div class="codelink"><a href="source/remote/index.js.src.html#l371">View Source</a></div><h1>class DriverService</h1><p>Manages the life and death of a native executable WebDriver server.</p>
2
- <p>It is expected that the driver server implements the
3
- https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol.
4
- Furthermore, the managed server should support multiple concurrent sessions,
5
- so that this class may be reused for multiple clients.</p>
6
- <h3>new DriverService(<wbr>executable, options)</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>executable<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>Path to the executable to run.</p>
7
- <dt>options<code>{args: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;|<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>), env: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), loopback: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), path: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), port: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>|<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>), stdio: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;?(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>|Stream)&gt;|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>)}</code><dd><p>Configuration options for the service.</p>
8
- </dl></div></div><h2>Instance Methods</h2><div id="address" class="function"><div><h3>address()<span class="codelink"><a href="source/remote/index.js.src.html#l133">code »</a></span></h3><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code><dd><p>A promise that resolves to
9
- the server&#39;s address.</p>
10
- </dl></div><div class="fn-details"><div><b>Throws</b></div><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a></code><dd><p>If the server has not been started.</p>
11
- </dl></div></div></div></div><hr class="fn-sep"><div id="isRunning" class="function"><div><h3>isRunning()<span class="codelink"><a href="source/remote/index.js.src.html#l146">code »</a></span></h3><p>Returns whether the underlying process is still running. This does not take
12
- into account whether the process is in the process of shutting down.</p>
13
- <div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether the underlying service process is running.</p>
14
- </dl></div></div></div></div><hr class="fn-sep"><div id="kill" class="function"><div><h3>kill()<span class="codelink"><a href="source/remote/index.js.src.html#l225">code »</a></span></h3><p>Stops the service if it is not currently running. This function will kill
15
- the server immediately. To synchronize with the active control flow, use
16
- <a href="module_selenium-webdriver_remote_class_DriverService.html#stop"><code>#stop()</code></a>.</p>
17
- <div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code><dd><p>A promise that will be resolved when
18
- the server has been stopped.</p>
19
- </dl></div></div></div></div><hr class="fn-sep"><div id="start" class="function"><div><h3>start(<wbr>opt_timeoutMs)<span class="codelink"><a href="source/remote/index.js.src.html#l160">code »</a></span></h3><p>Starts the server if it is not already running.</p>
20
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_timeoutMs<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>=</code><dd><p>How long to wait, in milliseconds, for the
21
- server to start accepting requests. Defaults to 30 seconds.</p>
22
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code><dd><p>A promise that will resolve
23
- to the server&#39;s base URL when it has started accepting requests. If the
24
- timeout expires before the server has started, the promise will be
25
- rejected.</p>
26
- </dl></div></div></div></div><hr class="fn-sep"><div id="stop" class="function"><div><h3>stop()<span class="codelink"><a href="source/remote/index.js.src.html#l241">code »</a></span></h3><p>Schedules a task in the current control flow to stop the server if it is
27
- currently running.</p>
28
- <div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code><dd><p>A promise that will be resolved when
29
- the server has been stopped.</p>
30
- </dl></div></div></div></div><h2>Static Properties</h2><div id="DriverService.DEFAULT_START_TIMEOUT_MS" class="property"><dl><dt><a href="source/remote/index.js.src.html#l125">DriverService.DEFAULT_START_TIMEOUT_MS</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd><p>The default amount of time, in milliseconds, to wait for the server to
31
- start.</p>
32
- </dl></div></article><nav><h3><a href="index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="types.js"></script><script src="dossier.js"></script>
@@ -1,22 +0,0 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>FileDetector</title><link href="dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article><div class="parentlink"><b>Module:</b> <a href="module_selenium-webdriver_remote.html">selenium-webdriver/remote</a></div><div class="codelink"><a href="source/remote/index.js.src.html#l372">View Source</a></div><h1>class FileDetector</h1><div class="tags"><span>final</span></div><pre class="inheritance"><a href="class_webdriver_FileDetector.html">webdriver.FileDetector</a>
2
- &#x2514; FileDetector</pre><p>A <a href="class_webdriver_FileDetector.html"><code>webdriver.FileDetector</code></a> that may be used when running
3
- against a remote
4
- <a href="http://selenium-release.storage.googleapis.com/index.html">Selenium server</a>.</p>
5
- <p>When a file path on the local machine running this script is entered with
6
- <a href="class_webdriver_WebElement.html#sendKeys"><code>WebElement#sendKeys</code></a>, this file detector
7
- will transfer the specified file to the Selenium server&#39;s host; the sendKeys
8
- command will be updated to use the transfered file&#39;s path.</p>
9
- <p><strong>Note:</strong> This class depends on a non-standard command supported on the
10
- Java Selenium server. The file detector will fail if used with a server that
11
- only supports standard WebDriver commands (such as the ChromeDriver).</p>
12
- <h3>new FileDetector()</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dd>None.</dl></div></div><h2>Instance Methods</h2><div id="handleFile" class="function"><div><h3>handleFile(<wbr>driver, path)<span class="codelink"><a href="source/remote/index.js.src.html#l347">code »</a></span></h3><p>Handles the file specified by the given path, preparing it for use with
13
- the current browser. If the path does not refer to a valid file, it will
14
- be returned unchanged, otherwisee a path suitable for use with the current
15
- browser will be returned.</p>
16
- <p>This default implementation is a no-op. Subtypes may override this
17
- function for custom tailored file handling.</p>
18
- <p><b>Overrides: </b><a href="class_webdriver_FileDetector.html#handleFile">webdriver.FileDetector</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>driver<code><a href="class_webdriver_WebDriver.html">webdriver.WebDriver</a></code><dd><p>The driver for the current browser.</p>
19
- <dt>path<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The path to process.</p>
20
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</code><dd><p>A promise for the processed
21
- file path.</p>
22
- </dl></div></div></div></div></article><nav><h3><a href="index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="types.js"></script><script src="dossier.js"></script>
@@ -1,41 +0,0 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>SeleniumServer</title><link href="dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article><div class="parentlink"><b>Module:</b> <a href="module_selenium-webdriver_remote.html">selenium-webdriver/remote</a></div><div class="codelink"><a href="source/remote/index.js.src.html#l373">View Source</a></div><h1>class SeleniumServer</h1><pre class="inheritance"><a href="module_selenium-webdriver_remote_class_DriverService.html">DriverService</a>
2
- &#x2514; SeleniumServer</pre><p>Manages the life and death of the
3
- <a href="http://selenium-release.storage.googleapis.com/index.html">
4
- standalone Selenium server</a>.</p>
5
- <h3>new SeleniumServer(<wbr>jar, opt_options)</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>jar<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>Path to the Selenium server jar.</p>
6
- <dt>opt_options<code>{args: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;|<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>), env: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), jvmArgs: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;|<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), loopback: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), port: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>|<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>), stdio: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;?(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>|Stream)&gt;|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>)}=</code><dd><p>Configuration options for the
7
- server.</p>
8
- </dl></div><div class="fn-details"><div><b>Throws</b></div><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a></code><dd><p>If the path to the Selenium jar is not specified or if an
9
- invalid port is specified.</p>
10
- </dl></div></div><h2>Instance Methods</h2><div id="address" class="function"><div><h3>address()<span class="codelink"><a href="source/remote/index.js.src.html#l133">code »</a></span></h3><p><b>Defined by: </b><a href="module_selenium-webdriver_remote_class_DriverService.html#address">DriverService</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code><dd><p>A promise that resolves to
11
- the server&#39;s address.</p>
12
- </dl></div><div class="fn-details"><div><b>Throws</b></div><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a></code><dd><p>If the server has not been started.</p>
13
- </dl></div></div></div></div><hr class="fn-sep"><div id="isRunning" class="function"><div><h3>isRunning()<span class="codelink"><a href="source/remote/index.js.src.html#l146">code »</a></span></h3><p>Returns whether the underlying process is still running. This does not take
14
- into account whether the process is in the process of shutting down.</p>
15
- <p><b>Defined by: </b><a href="module_selenium-webdriver_remote_class_DriverService.html#isRunning">DriverService</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether the underlying service process is running.</p>
16
- </dl></div></div></div></div><hr class="fn-sep"><div id="kill" class="function"><div><h3>kill()<span class="codelink"><a href="source/remote/index.js.src.html#l225">code »</a></span></h3><p>Stops the service if it is not currently running. This function will kill
17
- the server immediately. To synchronize with the active control flow, use
18
- <a href="module_selenium-webdriver_remote_class_SeleniumServer.html#stop"><code>#stop()</code></a>.</p>
19
- <p><b>Defined by: </b><a href="module_selenium-webdriver_remote_class_DriverService.html#kill">DriverService</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code><dd><p>A promise that will be resolved when
20
- the server has been stopped.</p>
21
- </dl></div></div></div></div><hr class="fn-sep"><div id="start" class="function"><div><h3>start(<wbr>opt_timeoutMs)<span class="codelink"><a href="source/remote/index.js.src.html#l160">code »</a></span></h3><p>Starts the server if it is not already running.</p>
22
- <p><b>Defined by: </b><a href="module_selenium-webdriver_remote_class_DriverService.html#start">DriverService</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_timeoutMs<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>=</code><dd><p>How long to wait, in milliseconds, for the
23
- server to start accepting requests. Defaults to 30 seconds.</p>
24
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code><dd><p>A promise that will resolve
25
- to the server&#39;s base URL when it has started accepting requests. If the
26
- timeout expires before the server has started, the promise will be
27
- rejected.</p>
28
- </dl></div></div></div></div><hr class="fn-sep"><div id="stop" class="function"><div><h3>stop()<span class="codelink"><a href="source/remote/index.js.src.html#l241">code »</a></span></h3><p>Schedules a task in the current control flow to stop the server if it is
29
- currently running.</p>
30
- <p><b>Defined by: </b><a href="module_selenium-webdriver_remote_class_DriverService.html#stop">DriverService</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code><dd><p>A promise that will be resolved when
31
- the server has been stopped.</p>
32
- </dl></div></div></div></div><h2>Type Definitions</h2><div id="SeleniumServer.Options" class="property"><dl><dt><a href="source/remote/index.js.src.html#l320">SeleniumServer.Options</a><code>{args: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;|<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>), env: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), jvmArgs: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;|<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), loopback: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), port: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>|<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>), stdio: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;?(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>|Stream)&gt;|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>)}</code><dd><p>Options for the Selenium server:</p>
33
- <ul><li><code>loopback</code> - Whether the server should only be accessed on this host&#39;s
34
- loopback address.</li><li><code>port</code> - The port to start the server on (must be &gt; 0). If the port is
35
- provided as a promise, the service will wait for the promise to resolve
36
- before starting.</li><li><code>args</code> - The arguments to pass to the service. If a promise is provided,
37
- the service will wait for it to resolve before starting.</li><li><code>jvmArgs</code> - The arguments to pass to the JVM. If a promise is provided,
38
- the service will wait for it to resolve before starting.</li><li><code>env</code> - The environment variables that should be visible to the server
39
- process. Defaults to inheriting the current process&#39;s environment.</li><li><code>stdio</code> - IO configuration for the spawned server process. For more
40
- information, refer to the documentation of <code>child_process.spawn</code>.</li></ul>
41
- </dl></div></article><nav><h3><a href="index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="types.js"></script><script src="dossier.js"></script>