selenium-webdriver 2.47.0 → 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 (529) hide show
  1. package/CHANGES.md +96 -0
  2. package/NOTICE +1 -1
  3. package/README.md +57 -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 +80 -114
  12. package/firefox/extension.js +10 -19
  13. package/firefox/index.js +175 -171
  14. package/firefox/profile.js +221 -239
  15. package/http/index.js +396 -77
  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} +89 -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 +6 -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/promise.js +3093 -0
  34. package/lib/safari/client.js +697 -659
  35. package/lib/session.js +79 -0
  36. package/{test/promise_aplus_test.js → lib/symbols.js} +15 -25
  37. package/lib/test/build.js +4 -4
  38. package/lib/test/data/click_tests/disappearing_element.html +62 -0
  39. package/lib/test/data/click_tests/html5_submit_buttons.html +2 -1
  40. package/lib/test/data/click_tests/overlapping_elements.html +70 -0
  41. package/lib/test/data/click_tests/partially_overlapping_elements.html +124 -0
  42. package/lib/test/data/click_tests/wrapped_overlapping_elements.html +13 -0
  43. package/lib/test/data/readOnlyPage.html +3 -1
  44. package/lib/test/data/selectPage.html +18 -2
  45. package/lib/test/data/simpleTest.html +1 -0
  46. package/lib/test/fileserver.js +3 -4
  47. package/lib/test/index.js +13 -4
  48. package/lib/test/resources.js +1 -1
  49. package/lib/until.js +428 -0
  50. package/lib/webdriver.js +2351 -0
  51. package/net/portprober.js +15 -11
  52. package/opera.js +295 -314
  53. package/package.json +6 -5
  54. package/phantomjs.js +135 -140
  55. package/proxy.js +6 -4
  56. package/remote/index.js +234 -219
  57. package/safari.js +319 -310
  58. package/test/chrome/options_test.js +11 -9
  59. package/test/element_finding_test.js +51 -13
  60. package/test/error_test.js +163 -0
  61. package/test/execute_script_test.js +1 -1
  62. package/test/firefox/firefox_test.js +24 -0
  63. package/test/http/http_test.js +354 -43
  64. package/test/http/util_test.js +25 -23
  65. package/test/io_test.js +6 -1
  66. package/test/lib/by_test.js +127 -0
  67. package/test/lib/capabilities_test.js +84 -0
  68. package/test/lib/events_test.js +177 -0
  69. package/test/lib/logging_test.js +272 -0
  70. package/test/lib/promise_aplus_test.js +74 -0
  71. package/test/lib/promise_error_test.js +808 -0
  72. package/test/lib/promise_flow_test.js +2282 -0
  73. package/test/lib/promise_generator_test.js +308 -0
  74. package/test/lib/promise_test.js +996 -0
  75. package/test/lib/testutil.js +90 -0
  76. package/test/lib/until_test.js +436 -0
  77. package/test/lib/webdriver_test.js +2207 -0
  78. package/test/page_loading_test.js +7 -9
  79. package/test/stale_element_test.js +2 -2
  80. package/test/testing/assert_test.js +374 -0
  81. package/test/testing/index_test.js +9 -11
  82. package/testing/assert.js +334 -17
  83. package/testing/index.js +10 -0
  84. package/_base.js +0 -200
  85. package/docs/Changes.html +0 -317
  86. package/docs/class_bot_Error.html +0 -15
  87. package/docs/class_webdriver_ActionSequence.html +0 -115
  88. package/docs/class_webdriver_Alert.html +0 -24
  89. package/docs/class_webdriver_AlertPromise.html +0 -91
  90. package/docs/class_webdriver_Capabilities.html +0 -60
  91. package/docs/class_webdriver_Command.html +0 -15
  92. package/docs/class_webdriver_EventEmitter.html +0 -35
  93. package/docs/class_webdriver_FileDetector.html +0 -21
  94. package/docs/class_webdriver_Locator.html +0 -12
  95. package/docs/class_webdriver_Serializable.html +0 -9
  96. package/docs/class_webdriver_Session.html +0 -13
  97. package/docs/class_webdriver_TouchSequence.html +0 -49
  98. package/docs/class_webdriver_UnhandledAlertError.html +0 -18
  99. package/docs/class_webdriver_WebDriver.html +0 -313
  100. package/docs/class_webdriver_WebDriver_Logs.html +0 -15
  101. package/docs/class_webdriver_WebDriver_Navigation.html +0 -16
  102. package/docs/class_webdriver_WebDriver_Options.html +0 -41
  103. package/docs/class_webdriver_WebDriver_TargetLocator.html +0 -38
  104. package/docs/class_webdriver_WebDriver_Timeouts.html +0 -29
  105. package/docs/class_webdriver_WebDriver_Window.html +0 -27
  106. package/docs/class_webdriver_WebElement.html +0 -216
  107. package/docs/class_webdriver_WebElementPromise.html +0 -266
  108. package/docs/class_webdriver_http_Executor.html +0 -22
  109. package/docs/class_webdriver_http_Request.html +0 -12
  110. package/docs/class_webdriver_http_Response.html +0 -13
  111. package/docs/class_webdriver_logging_Entry.html +0 -15
  112. package/docs/class_webdriver_logging_Level.html +0 -55
  113. package/docs/class_webdriver_logging_LogRecord.html +0 -45
  114. package/docs/class_webdriver_logging_Logger.html +0 -119
  115. package/docs/class_webdriver_logging_Preferences.html +0 -8
  116. package/docs/class_webdriver_promise_CancellationError.html +0 -18
  117. package/docs/class_webdriver_promise_ControlFlow.html +0 -109
  118. package/docs/class_webdriver_promise_Deferred.html +0 -84
  119. package/docs/class_webdriver_promise_Promise.html +0 -74
  120. package/docs/class_webdriver_stacktrace_Frame.html +0 -20
  121. package/docs/class_webdriver_stacktrace_Snapshot.html +0 -6
  122. package/docs/class_webdriver_testing_Assertion.html +0 -99
  123. package/docs/class_webdriver_testing_Assertion_DelegatingMatcher_.html +0 -13
  124. package/docs/class_webdriver_testing_ContainsMatcher.html +0 -11
  125. package/docs/class_webdriver_testing_NegatedAssertion.html +0 -97
  126. package/docs/class_webdriver_until_Condition.html +0 -7
  127. package/docs/dossier.css +0 -1
  128. package/docs/dossier.js +0 -86
  129. package/docs/enum_bot_ErrorCode.html +0 -3
  130. package/docs/enum_bot_Error_State.html +0 -2
  131. package/docs/enum_webdriver_Browser.html +0 -2
  132. package/docs/enum_webdriver_Button.html +0 -2
  133. package/docs/enum_webdriver_Capability.html +0 -33
  134. package/docs/enum_webdriver_CommandName.html +0 -3
  135. package/docs/enum_webdriver_Key.html +0 -12
  136. package/docs/enum_webdriver_logging_Type.html +0 -6
  137. package/docs/enum_webdriver_promise_ControlFlow_EventType.html +0 -9
  138. package/docs/index.html +0 -123
  139. package/docs/interface_webdriver_CommandExecutor.html +0 -9
  140. package/docs/interface_webdriver_http_Client.html +0 -10
  141. package/docs/interface_webdriver_promise_Thenable.html +0 -77
  142. package/docs/module_selenium-webdriver.html +0 -23
  143. package/docs/module_selenium-webdriver__base.html +0 -23
  144. package/docs/module_selenium-webdriver__base_class_Context.html +0 -5
  145. package/docs/module_selenium-webdriver_builder.html +0 -2
  146. package/docs/module_selenium-webdriver_builder_class_Builder.html +0 -138
  147. package/docs/module_selenium-webdriver_chrome.html +0 -90
  148. package/docs/module_selenium-webdriver_chrome_class_Driver.html +0 -280
  149. package/docs/module_selenium-webdriver_chrome_class_Options.html +0 -127
  150. package/docs/module_selenium-webdriver_chrome_class_ServiceBuilder.html +0 -46
  151. package/docs/module_selenium-webdriver_class_ActionSequence.html +0 -115
  152. package/docs/module_selenium-webdriver_class_Builder.html +0 -138
  153. package/docs/module_selenium-webdriver_class_Capabilities.html +0 -60
  154. package/docs/module_selenium-webdriver_class_Command.html +0 -15
  155. package/docs/module_selenium-webdriver_class_EventEmitter.html +0 -35
  156. package/docs/module_selenium-webdriver_class_FileDetector.html +0 -21
  157. package/docs/module_selenium-webdriver_class_Serializable.html +0 -9
  158. package/docs/module_selenium-webdriver_class_Session.html +0 -13
  159. package/docs/module_selenium-webdriver_class_WebDriver.html +0 -313
  160. package/docs/module_selenium-webdriver_class_WebElement.html +0 -216
  161. package/docs/module_selenium-webdriver_class_WebElementPromise.html +0 -266
  162. package/docs/module_selenium-webdriver_enum_Browser.html +0 -2
  163. package/docs/module_selenium-webdriver_enum_Button.html +0 -2
  164. package/docs/module_selenium-webdriver_enum_Capability.html +0 -33
  165. package/docs/module_selenium-webdriver_enum_CommandName.html +0 -3
  166. package/docs/module_selenium-webdriver_enum_Key.html +0 -12
  167. package/docs/module_selenium-webdriver_error.html +0 -4
  168. package/docs/module_selenium-webdriver_error_class_Error.html +0 -15
  169. package/docs/module_selenium-webdriver_error_enum_ErrorCode.html +0 -3
  170. package/docs/module_selenium-webdriver_executors.html +0 -10
  171. package/docs/module_selenium-webdriver_executors_class_DeferredExecutor.html +0 -12
  172. package/docs/module_selenium-webdriver_firefox.html +0 -67
  173. package/docs/module_selenium-webdriver_firefox_binary.html +0 -4
  174. package/docs/module_selenium-webdriver_firefox_binary_class_Binary.html +0 -21
  175. package/docs/module_selenium-webdriver_firefox_class_Binary.html +0 -21
  176. package/docs/module_selenium-webdriver_firefox_class_Driver.html +0 -276
  177. package/docs/module_selenium-webdriver_firefox_class_Options.html +0 -19
  178. package/docs/module_selenium-webdriver_firefox_class_Profile.html +0 -50
  179. package/docs/module_selenium-webdriver_firefox_extension.html +0 -8
  180. package/docs/module_selenium-webdriver_firefox_profile.html +0 -13
  181. package/docs/module_selenium-webdriver_firefox_profile_class_Profile.html +0 -50
  182. package/docs/module_selenium-webdriver_http.html +0 -9
  183. package/docs/module_selenium-webdriver_http_class_Executor.html +0 -22
  184. package/docs/module_selenium-webdriver_http_class_HttpClient.html +0 -16
  185. package/docs/module_selenium-webdriver_http_class_Request.html +0 -12
  186. package/docs/module_selenium-webdriver_http_class_Response.html +0 -13
  187. package/docs/module_selenium-webdriver_http_util.html +0 -17
  188. package/docs/module_selenium-webdriver_ie.html +0 -11
  189. package/docs/module_selenium-webdriver_ie_class_Driver.html +0 -274
  190. package/docs/module_selenium-webdriver_ie_class_Options.html +0 -89
  191. package/docs/module_selenium-webdriver_ie_enum_Level.html +0 -1
  192. package/docs/module_selenium-webdriver_io.html +0 -37
  193. package/docs/module_selenium-webdriver_io_exec.html +0 -6
  194. package/docs/module_selenium-webdriver_namespace_By.html +0 -56
  195. package/docs/module_selenium-webdriver_namespace_error.html +0 -4
  196. package/docs/module_selenium-webdriver_namespace_logging.html +0 -18
  197. package/docs/module_selenium-webdriver_namespace_promise.html +0 -162
  198. package/docs/module_selenium-webdriver_namespace_stacktrace.html +0 -17
  199. package/docs/module_selenium-webdriver_namespace_until.html +0 -82
  200. package/docs/module_selenium-webdriver_net.html +0 -7
  201. package/docs/module_selenium-webdriver_net_portprober.html +0 -12
  202. package/docs/module_selenium-webdriver_opera.html +0 -62
  203. package/docs/module_selenium-webdriver_opera_class_Driver.html +0 -276
  204. package/docs/module_selenium-webdriver_opera_class_Options.html +0 -44
  205. package/docs/module_selenium-webdriver_opera_class_ServiceBuilder.html +0 -35
  206. package/docs/module_selenium-webdriver_phantomjs.html +0 -2
  207. package/docs/module_selenium-webdriver_phantomjs_class_Driver.html +0 -299
  208. package/docs/module_selenium-webdriver_proxy.html +0 -28
  209. package/docs/module_selenium-webdriver_remote.html +0 -8
  210. package/docs/module_selenium-webdriver_remote_class_DriverService.html +0 -32
  211. package/docs/module_selenium-webdriver_remote_class_FileDetector.html +0 -22
  212. package/docs/module_selenium-webdriver_remote_class_SeleniumServer.html +0 -40
  213. package/docs/module_selenium-webdriver_safari.html +0 -9
  214. package/docs/module_selenium-webdriver_safari_class_Driver.html +0 -279
  215. package/docs/module_selenium-webdriver_safari_class_Options.html +0 -23
  216. package/docs/module_selenium-webdriver_testing.html +0 -74
  217. package/docs/module_selenium-webdriver_testing_assert.html +0 -9
  218. package/docs/namespace_bot.html +0 -4
  219. package/docs/namespace_bot_json.html +0 -20
  220. package/docs/namespace_bot_response.html +0 -18
  221. package/docs/namespace_bot_userAgent.html +0 -33
  222. package/docs/namespace_webdriver.html +0 -30
  223. package/docs/namespace_webdriver_By.html +0 -56
  224. package/docs/namespace_webdriver_http.html +0 -6
  225. package/docs/namespace_webdriver_logging.html +0 -70
  226. package/docs/namespace_webdriver_promise.html +0 -165
  227. package/docs/namespace_webdriver_stacktrace.html +0 -17
  228. package/docs/namespace_webdriver_testing.html +0 -7
  229. package/docs/namespace_webdriver_testing_assert.html +0 -9
  230. package/docs/namespace_webdriver_testing_asserts.html +0 -18
  231. package/docs/namespace_webdriver_until.html +0 -82
  232. package/docs/source/_base.js.src.html +0 -1
  233. package/docs/source/builder.js.src.html +0 -1
  234. package/docs/source/chrome.js.src.html +0 -1
  235. package/docs/source/error.js.src.html +0 -1
  236. package/docs/source/executors.js.src.html +0 -1
  237. package/docs/source/firefox/binary.js.src.html +0 -1
  238. package/docs/source/firefox/extension.js.src.html +0 -1
  239. package/docs/source/firefox/index.js.src.html +0 -1
  240. package/docs/source/firefox/profile.js.src.html +0 -1
  241. package/docs/source/http/index.js.src.html +0 -1
  242. package/docs/source/http/util.js.src.html +0 -1
  243. package/docs/source/ie.js.src.html +0 -1
  244. package/docs/source/index.js.src.html +0 -1
  245. package/docs/source/io/exec.js.src.html +0 -1
  246. package/docs/source/io/index.js.src.html +0 -1
  247. package/docs/source/lib/atoms/error.js.src.html +0 -1
  248. package/docs/source/lib/atoms/json.js.src.html +0 -1
  249. package/docs/source/lib/atoms/response.js.src.html +0 -1
  250. package/docs/source/lib/atoms/userAgent.js.src.html +0 -1
  251. package/docs/source/lib/goog/array/array.js.src.html +0 -1
  252. package/docs/source/lib/goog/asserts/asserts.js.src.html +0 -1
  253. package/docs/source/lib/goog/async/freelist.js.src.html +0 -1
  254. package/docs/source/lib/goog/async/nexttick.js.src.html +0 -1
  255. package/docs/source/lib/goog/async/run.js.src.html +0 -1
  256. package/docs/source/lib/goog/async/workqueue.js.src.html +0 -1
  257. package/docs/source/lib/goog/base.js.src.html +0 -1
  258. package/docs/source/lib/goog/debug/debug.js.src.html +0 -1
  259. package/docs/source/lib/goog/debug/entrypointregistry.js.src.html +0 -1
  260. package/docs/source/lib/goog/debug/error.js.src.html +0 -1
  261. package/docs/source/lib/goog/debug/logbuffer.js.src.html +0 -1
  262. package/docs/source/lib/goog/debug/logger.js.src.html +0 -1
  263. package/docs/source/lib/goog/debug/logrecord.js.src.html +0 -1
  264. package/docs/source/lib/goog/deps.js.src.html +0 -1
  265. package/docs/source/lib/goog/disposable/disposable.js.src.html +0 -1
  266. package/docs/source/lib/goog/disposable/idisposable.js.src.html +0 -1
  267. package/docs/source/lib/goog/dom/browserfeature.js.src.html +0 -1
  268. package/docs/source/lib/goog/dom/dom.js.src.html +0 -1
  269. package/docs/source/lib/goog/dom/nodetype.js.src.html +0 -1
  270. package/docs/source/lib/goog/dom/safe.js.src.html +0 -1
  271. package/docs/source/lib/goog/dom/tagname.js.src.html +0 -1
  272. package/docs/source/lib/goog/dom/tags.js.src.html +0 -1
  273. package/docs/source/lib/goog/dom/vendor.js.src.html +0 -1
  274. package/docs/source/lib/goog/events/browserevent.js.src.html +0 -1
  275. package/docs/source/lib/goog/events/browserfeature.js.src.html +0 -1
  276. package/docs/source/lib/goog/events/event.js.src.html +0 -1
  277. package/docs/source/lib/goog/events/eventid.js.src.html +0 -1
  278. package/docs/source/lib/goog/events/events.js.src.html +0 -1
  279. package/docs/source/lib/goog/events/eventtarget.js.src.html +0 -1
  280. package/docs/source/lib/goog/events/eventtype.js.src.html +0 -1
  281. package/docs/source/lib/goog/events/keycodes.js.src.html +0 -1
  282. package/docs/source/lib/goog/events/listenable.js.src.html +0 -1
  283. package/docs/source/lib/goog/events/listener.js.src.html +0 -1
  284. package/docs/source/lib/goog/events/listenermap.js.src.html +0 -1
  285. package/docs/source/lib/goog/fs/url.js.src.html +0 -1
  286. package/docs/source/lib/goog/functions/functions.js.src.html +0 -1
  287. package/docs/source/lib/goog/html/safehtml.js.src.html +0 -1
  288. package/docs/source/lib/goog/html/safescript.js.src.html +0 -1
  289. package/docs/source/lib/goog/html/safestyle.js.src.html +0 -1
  290. package/docs/source/lib/goog/html/safestylesheet.js.src.html +0 -1
  291. package/docs/source/lib/goog/html/safeurl.js.src.html +0 -1
  292. package/docs/source/lib/goog/html/trustedresourceurl.js.src.html +0 -1
  293. package/docs/source/lib/goog/html/uncheckedconversions.js.src.html +0 -1
  294. package/docs/source/lib/goog/i18n/bidi.js.src.html +0 -1
  295. package/docs/source/lib/goog/iter/iter.js.src.html +0 -1
  296. package/docs/source/lib/goog/json/json.js.src.html +0 -1
  297. package/docs/source/lib/goog/labs/testing/assertthat.js.src.html +0 -1
  298. package/docs/source/lib/goog/labs/testing/logicmatcher.js.src.html +0 -1
  299. package/docs/source/lib/goog/labs/testing/matcher.js.src.html +0 -1
  300. package/docs/source/lib/goog/labs/testing/numbermatcher.js.src.html +0 -1
  301. package/docs/source/lib/goog/labs/testing/objectmatcher.js.src.html +0 -1
  302. package/docs/source/lib/goog/labs/testing/stringmatcher.js.src.html +0 -1
  303. package/docs/source/lib/goog/labs/useragent/browser.js.src.html +0 -1
  304. package/docs/source/lib/goog/labs/useragent/engine.js.src.html +0 -1
  305. package/docs/source/lib/goog/labs/useragent/platform.js.src.html +0 -1
  306. package/docs/source/lib/goog/labs/useragent/util.js.src.html +0 -1
  307. package/docs/source/lib/goog/math/box.js.src.html +0 -1
  308. package/docs/source/lib/goog/math/coordinate.js.src.html +0 -1
  309. package/docs/source/lib/goog/math/math.js.src.html +0 -1
  310. package/docs/source/lib/goog/math/rect.js.src.html +0 -1
  311. package/docs/source/lib/goog/math/size.js.src.html +0 -1
  312. package/docs/source/lib/goog/net/wrapperxmlhttpfactory.js.src.html +0 -1
  313. package/docs/source/lib/goog/net/xhrlike.js.src.html +0 -1
  314. package/docs/source/lib/goog/net/xmlhttp.js.src.html +0 -1
  315. package/docs/source/lib/goog/net/xmlhttpfactory.js.src.html +0 -1
  316. package/docs/source/lib/goog/object/object.js.src.html +0 -1
  317. package/docs/source/lib/goog/promise/promise.js.src.html +0 -1
  318. package/docs/source/lib/goog/promise/resolver.js.src.html +0 -1
  319. package/docs/source/lib/goog/promise/thenable.js.src.html +0 -1
  320. package/docs/source/lib/goog/reflect/reflect.js.src.html +0 -1
  321. package/docs/source/lib/goog/string/const.js.src.html +0 -1
  322. package/docs/source/lib/goog/string/string.js.src.html +0 -1
  323. package/docs/source/lib/goog/string/typedstring.js.src.html +0 -1
  324. package/docs/source/lib/goog/structs/collection.js.src.html +0 -1
  325. package/docs/source/lib/goog/structs/map.js.src.html +0 -1
  326. package/docs/source/lib/goog/structs/set.js.src.html +0 -1
  327. package/docs/source/lib/goog/structs/structs.js.src.html +0 -1
  328. package/docs/source/lib/goog/style/style.js.src.html +0 -1
  329. package/docs/source/lib/goog/testing/asserts.js.src.html +0 -1
  330. package/docs/source/lib/goog/testing/events/events.js.src.html +0 -1
  331. package/docs/source/lib/goog/testing/functionmock.js.src.html +0 -1
  332. package/docs/source/lib/goog/testing/jsunit.js.src.html +0 -1
  333. package/docs/source/lib/goog/testing/loosemock.js.src.html +0 -1
  334. package/docs/source/lib/goog/testing/mock.js.src.html +0 -1
  335. package/docs/source/lib/goog/testing/mockclock.js.src.html +0 -1
  336. package/docs/source/lib/goog/testing/mockcontrol.js.src.html +0 -1
  337. package/docs/source/lib/goog/testing/mockinterface.js.src.html +0 -1
  338. package/docs/source/lib/goog/testing/mockmatchers.js.src.html +0 -1
  339. package/docs/source/lib/goog/testing/objectpropertystring.js.src.html +0 -1
  340. package/docs/source/lib/goog/testing/propertyreplacer.js.src.html +0 -1
  341. package/docs/source/lib/goog/testing/recordfunction.js.src.html +0 -1
  342. package/docs/source/lib/goog/testing/stacktrace.js.src.html +0 -1
  343. package/docs/source/lib/goog/testing/strictmock.js.src.html +0 -1
  344. package/docs/source/lib/goog/testing/testcase.js.src.html +0 -1
  345. package/docs/source/lib/goog/testing/testrunner.js.src.html +0 -1
  346. package/docs/source/lib/goog/testing/watchers.js.src.html +0 -1
  347. package/docs/source/lib/goog/uri/uri.js.src.html +0 -1
  348. package/docs/source/lib/goog/uri/utils.js.src.html +0 -1
  349. package/docs/source/lib/goog/useragent/product.js.src.html +0 -1
  350. package/docs/source/lib/goog/useragent/product_isversion.js.src.html +0 -1
  351. package/docs/source/lib/goog/useragent/useragent.js.src.html +0 -1
  352. package/docs/source/lib/webdriver/actionsequence.js.src.html +0 -1
  353. package/docs/source/lib/webdriver/button.js.src.html +0 -1
  354. package/docs/source/lib/webdriver/capabilities.js.src.html +0 -1
  355. package/docs/source/lib/webdriver/command.js.src.html +0 -1
  356. package/docs/source/lib/webdriver/events.js.src.html +0 -1
  357. package/docs/source/lib/webdriver/http/http.js.src.html +0 -1
  358. package/docs/source/lib/webdriver/key.js.src.html +0 -1
  359. package/docs/source/lib/webdriver/locators.js.src.html +0 -1
  360. package/docs/source/lib/webdriver/logging.js.src.html +0 -1
  361. package/docs/source/lib/webdriver/promise.js.src.html +0 -1
  362. package/docs/source/lib/webdriver/serializable.js.src.html +0 -1
  363. package/docs/source/lib/webdriver/session.js.src.html +0 -1
  364. package/docs/source/lib/webdriver/stacktrace.js.src.html +0 -1
  365. package/docs/source/lib/webdriver/testing/asserts.js.src.html +0 -1
  366. package/docs/source/lib/webdriver/touchsequence.js.src.html +0 -1
  367. package/docs/source/lib/webdriver/until.js.src.html +0 -1
  368. package/docs/source/lib/webdriver/webdriver.js.src.html +0 -1
  369. package/docs/source/net/index.js.src.html +0 -1
  370. package/docs/source/net/portprober.js.src.html +0 -1
  371. package/docs/source/opera.js.src.html +0 -1
  372. package/docs/source/phantomjs.js.src.html +0 -1
  373. package/docs/source/proxy.js.src.html +0 -1
  374. package/docs/source/remote/index.js.src.html +0 -1
  375. package/docs/source/safari.js.src.html +0 -1
  376. package/docs/source/testing/assert.js.src.html +0 -1
  377. package/docs/source/testing/index.js.src.html +0 -1
  378. package/docs/types.js +0 -1
  379. package/lib/atoms/error.js +0 -202
  380. package/lib/atoms/json.js +0 -80
  381. package/lib/atoms/response.js +0 -110
  382. package/lib/atoms/userAgent.js +0 -257
  383. package/lib/goog/LICENSE +0 -176
  384. package/lib/goog/array/array.js +0 -1655
  385. package/lib/goog/asserts/asserts.js +0 -365
  386. package/lib/goog/async/freelist.js +0 -88
  387. package/lib/goog/async/nexttick.js +0 -241
  388. package/lib/goog/async/run.js +0 -139
  389. package/lib/goog/async/workqueue.js +0 -139
  390. package/lib/goog/base.js +0 -2547
  391. package/lib/goog/debug/debug.js +0 -653
  392. package/lib/goog/debug/entrypointregistry.js +0 -158
  393. package/lib/goog/debug/error.js +0 -63
  394. package/lib/goog/debug/logbuffer.js +0 -148
  395. package/lib/goog/debug/logger.js +0 -873
  396. package/lib/goog/debug/logrecord.js +0 -242
  397. package/lib/goog/deps.js +0 -151
  398. package/lib/goog/disposable/disposable.js +0 -307
  399. package/lib/goog/disposable/idisposable.js +0 -45
  400. package/lib/goog/dom/browserfeature.js +0 -72
  401. package/lib/goog/dom/dom.js +0 -2995
  402. package/lib/goog/dom/nodetype.js +0 -48
  403. package/lib/goog/dom/safe.js +0 -347
  404. package/lib/goog/dom/tagname.js +0 -160
  405. package/lib/goog/dom/tags.js +0 -42
  406. package/lib/goog/dom/vendor.js +0 -96
  407. package/lib/goog/events/browserevent.js +0 -386
  408. package/lib/goog/events/browserfeature.js +0 -85
  409. package/lib/goog/events/event.js +0 -143
  410. package/lib/goog/events/eventid.js +0 -47
  411. package/lib/goog/events/events.js +0 -984
  412. package/lib/goog/events/eventtarget.js +0 -394
  413. package/lib/goog/events/eventtype.js +0 -233
  414. package/lib/goog/events/keycodes.js +0 -420
  415. package/lib/goog/events/listenable.js +0 -335
  416. package/lib/goog/events/listener.js +0 -131
  417. package/lib/goog/events/listenermap.js +0 -308
  418. package/lib/goog/fs/url.js +0 -105
  419. package/lib/goog/functions/functions.js +0 -332
  420. package/lib/goog/html/safehtml.js +0 -756
  421. package/lib/goog/html/safescript.js +0 -234
  422. package/lib/goog/html/safestyle.js +0 -442
  423. package/lib/goog/html/safestylesheet.js +0 -276
  424. package/lib/goog/html/safeurl.js +0 -431
  425. package/lib/goog/html/trustedresourceurl.js +0 -224
  426. package/lib/goog/html/uncheckedconversions.js +0 -231
  427. package/lib/goog/i18n/bidi.js +0 -908
  428. package/lib/goog/iter/iter.js +0 -1305
  429. package/lib/goog/json/json.js +0 -365
  430. package/lib/goog/labs/testing/assertthat.js +0 -58
  431. package/lib/goog/labs/testing/logicmatcher.js +0 -212
  432. package/lib/goog/labs/testing/matcher.js +0 -80
  433. package/lib/goog/labs/testing/numbermatcher.js +0 -346
  434. package/lib/goog/labs/testing/objectmatcher.js +0 -317
  435. package/lib/goog/labs/testing/stringmatcher.js +0 -415
  436. package/lib/goog/labs/useragent/browser.js +0 -327
  437. package/lib/goog/labs/useragent/engine.js +0 -160
  438. package/lib/goog/labs/useragent/platform.js +0 -160
  439. package/lib/goog/labs/useragent/util.js +0 -148
  440. package/lib/goog/math/box.js +0 -389
  441. package/lib/goog/math/coordinate.js +0 -268
  442. package/lib/goog/math/math.js +0 -451
  443. package/lib/goog/math/rect.js +0 -476
  444. package/lib/goog/math/size.js +0 -227
  445. package/lib/goog/net/wrapperxmlhttpfactory.js +0 -71
  446. package/lib/goog/net/xhrlike.js +0 -124
  447. package/lib/goog/net/xmlhttp.js +0 -246
  448. package/lib/goog/net/xmlhttpfactory.js +0 -67
  449. package/lib/goog/object/object.js +0 -686
  450. package/lib/goog/promise/promise.js +0 -1310
  451. package/lib/goog/promise/resolver.js +0 -48
  452. package/lib/goog/promise/thenable.js +0 -126
  453. package/lib/goog/reflect/reflect.js +0 -78
  454. package/lib/goog/string/const.js +0 -182
  455. package/lib/goog/string/string.js +0 -1565
  456. package/lib/goog/string/typedstring.js +0 -48
  457. package/lib/goog/structs/collection.js +0 -56
  458. package/lib/goog/structs/map.js +0 -456
  459. package/lib/goog/structs/set.js +0 -279
  460. package/lib/goog/structs/structs.js +0 -354
  461. package/lib/goog/style/style.js +0 -2054
  462. package/lib/goog/testing/asserts.js +0 -1265
  463. package/lib/goog/testing/events/events.js +0 -727
  464. package/lib/goog/testing/functionmock.js +0 -176
  465. package/lib/goog/testing/jsunit.js +0 -162
  466. package/lib/goog/testing/loosemock.js +0 -242
  467. package/lib/goog/testing/mock.js +0 -645
  468. package/lib/goog/testing/mockclock.js +0 -617
  469. package/lib/goog/testing/mockcontrol.js +0 -220
  470. package/lib/goog/testing/mockinterface.js +0 -45
  471. package/lib/goog/testing/mockmatchers.js +0 -400
  472. package/lib/goog/testing/objectpropertystring.js +0 -68
  473. package/lib/goog/testing/propertyreplacer.js +0 -245
  474. package/lib/goog/testing/recordfunction.js +0 -215
  475. package/lib/goog/testing/stacktrace.js +0 -594
  476. package/lib/goog/testing/strictmock.js +0 -130
  477. package/lib/goog/testing/testcase.js +0 -1569
  478. package/lib/goog/testing/testrunner.js +0 -440
  479. package/lib/goog/testing/watchers.js +0 -46
  480. package/lib/goog/uri/uri.js +0 -1507
  481. package/lib/goog/uri/utils.js +0 -1116
  482. package/lib/goog/useragent/product.js +0 -175
  483. package/lib/goog/useragent/product_isversion.js +0 -143
  484. package/lib/goog/useragent/useragent.js +0 -538
  485. package/lib/webdriver/actionsequence.js +0 -356
  486. package/lib/webdriver/builder.js +0 -208
  487. package/lib/webdriver/capabilities.js +0 -411
  488. package/lib/webdriver/events.js +0 -179
  489. package/lib/webdriver/firefoxdomexecutor.js +0 -175
  490. package/lib/webdriver/http/corsclient.js +0 -133
  491. package/lib/webdriver/http/http.js +0 -523
  492. package/lib/webdriver/http/xhrclient.js +0 -67
  493. package/lib/webdriver/locators.js +0 -257
  494. package/lib/webdriver/logging.js +0 -347
  495. package/lib/webdriver/promise.js +0 -2609
  496. package/lib/webdriver/serializable.js +0 -41
  497. package/lib/webdriver/session.js +0 -74
  498. package/lib/webdriver/stacktrace.js +0 -619
  499. package/lib/webdriver/test/builder_test.js +0 -53
  500. package/lib/webdriver/test/capabilities_test.js +0 -72
  501. package/lib/webdriver/test/events_test.js +0 -203
  502. package/lib/webdriver/test/http/corsclient_test.js +0 -151
  503. package/lib/webdriver/test/http/http_test.js +0 -428
  504. package/lib/webdriver/test/http/xhrclient_test.js +0 -196
  505. package/lib/webdriver/test/locators_test.js +0 -59
  506. package/lib/webdriver/test/logging_test.js +0 -85
  507. package/lib/webdriver/test/promise_error_test.js +0 -719
  508. package/lib/webdriver/test/promise_flow_test.js +0 -1957
  509. package/lib/webdriver/test/promise_generator_test.js +0 -251
  510. package/lib/webdriver/test/promise_test.js +0 -1981
  511. package/lib/webdriver/test/stacktrace_test.js +0 -480
  512. package/lib/webdriver/test/test_bootstrap.js +0 -67
  513. package/lib/webdriver/test/testing/asserts_test.js +0 -117
  514. package/lib/webdriver/test/testing/client_test.js +0 -88
  515. package/lib/webdriver/test/testing/testcase_test.js +0 -229
  516. package/lib/webdriver/test/testutil.js +0 -209
  517. package/lib/webdriver/test/testutil_test.js +0 -104
  518. package/lib/webdriver/test/until_test.js +0 -411
  519. package/lib/webdriver/test/webdriver_generator_test.js +0 -92
  520. package/lib/webdriver/test/webdriver_test.js +0 -2369
  521. package/lib/webdriver/testing/asserts.js +0 -487
  522. package/lib/webdriver/testing/client.js +0 -179
  523. package/lib/webdriver/testing/jsunit.js +0 -363
  524. package/lib/webdriver/testing/testcase.js +0 -168
  525. package/lib/webdriver/testing/window.js +0 -244
  526. package/lib/webdriver/touchsequence.js +0 -248
  527. package/lib/webdriver/until.js +0 -412
  528. package/lib/webdriver/webdriver.js +0 -2492
  529. package/test/_base_test.js +0 -129
@@ -1,9 +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/safari</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/safari.js.src.html#l27">View Source</a></div><h1>module selenium-webdriver/safari</h1><p>Defines a WebDriver client for Safari. Before using this
2
- module, you must install the
3
- <a href="http://selenium-release.storage.googleapis.com/index.html">latest version</a>
4
- of the SafariDriver browser extension; using Safari for normal browsing is
5
- not recommended once the extension has been installed. You can, and should,
6
- disable the extension when the browser is not being used with WebDriver.</p>
7
- <h2>Types</h2><dl><dt><a href="module_selenium-webdriver_safari_class_Driver.html">Driver</a><dd><p>A WebDriver client for Safari.</p>
8
- <dt><a href="module_selenium-webdriver_safari_class_Options.html">Options</a><dd><p>Configuration options specific to the <a href="module_selenium-webdriver_safari_class_Driver.html"><code>SafariDriver</code></a>.</p>
9
- </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,279 +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_safari.html">selenium-webdriver/safari</a></div><div class="codelink"><a href="source/safari.js.src.html#l537">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>A WebDriver client for Safari. This class should never be instantiated
3
- directly; instead, use the <a href="module_selenium-webdriver_class_Builder.html"><code>selenium-webdriver.Builder</code></a>:</p>
4
- <pre><code>var driver &#61; new Builder()
5
- .forBrowser(&#39;safari&#39;)
6
- .build();
7
- </code></pre>
8
- <h3>new Driver(<wbr>opt_config, opt_flow)</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_config<code>?(<a href="module_selenium-webdriver_safari_class_Options.html">Options</a>|<a href="module_selenium-webdriver_class_Capabilities.html">Capabilities</a>)=</code><dd><p>The configuration
9
- options for the new session.</p>
10
- <dt>opt_flow<code>?<a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a>=</code><dd><p>The control flow to create
11
- the driver under.</p>
12
- </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
13
- scheduled for execution until <a href="class_webdriver_ActionSequence.html#perform"><code>webdriver.ActionSequence#perform</code></a> is
14
- called. Example:</p>
15
- <pre><code>driver.actions().
16
- mouseDown(element1).
17
- mouseMove(element2).
18
- mouseUp().
19
- perform();
20
- </code></pre>
21
- <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>
22
- </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>
23
- <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
24
- execute.</p>
25
- <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>
26
- <dt>var_args<code>...*</code><dd><p>Any arguments to pass to the function.</p>
27
- </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;
28
- with the function&#39;s result.</p>
29
- </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>
30
- <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
31
- when this command has completed.</p>
32
- </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
33
- instance.</p>
34
- </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
35
- currently selected frame or window. The script fragment will be executed as
36
- the body of an anonymous function. If the script is provided as a function
37
- object, that function will be converted to a string for injection into the
38
- target window.</p>
39
- <p>Any arguments provided in addition to the script will be included as script
40
- arguments and may be referenced using the <code>arguments</code> object.
41
- Arguments may be a boolean, number, string, or <code>webdriver.WebElement</code>.
42
- Arrays and objects may also be used as script arguments as long as each item
43
- adheres to the types previously mentioned.</p>
44
- <p>Unlike executing synchronous JavaScript with <a href="module_selenium-webdriver_safari_class_Driver.html#executeScript"><code>#executeScript</code></a>,
45
- scripts executed with this function must explicitly signal they are finished
46
- by invoking the provided callback. This callback will always be injected
47
- into the executed function as the last argument, and thus may be referenced
48
- with <code>arguments[arguments.length - 1]</code>. The following steps will be
49
- taken for resolving this functions return value against the first argument
50
- to the script&#39;s callback function:</p>
51
- <ul><li>For a HTML element, the value will resolve to a
52
- <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
53
- the rules above</li></ul>
54
- <p><strong>Example #1:</strong> Performing a sleep that is synchronized with the currently
55
- selected window:</p>
56
- <pre><code>var start &#61; new Date().getTime();
57
- driver.executeAsyncScript(
58
- &#39;window.setTimeout(arguments[arguments.length - 1], 500);&#39;).
59
- then(function() {
60
- console.log(
61
- &#39;Elapsed time: &#39; &#43; (new Date().getTime() - start) &#43; &#39; ms&#39;);
62
- });
63
- </code></pre>
64
- <p><strong>Example #2:</strong> Synchronizing a test with an AJAX application:</p>
65
- <pre><code>var button &#61; driver.findElement(By.id(&#39;compose-button&#39;));
66
- button.click();
67
- driver.executeAsyncScript(
68
- &#39;var callback &#61; arguments[arguments.length - 1];&#39; &#43;
69
- &#39;mailClient.getComposeWindowWidget().onload(callback);&#39;);
70
- driver.switchTo().frame(&#39;composeWidget&#39;);
71
- driver.findElement(By.id(&#39;to&#39;)).sendKeys(&#39;dog&#64;example.com&#39;);
72
- </code></pre>
73
- <p><strong>Example #3:</strong> Injecting a XMLHttpRequest and waiting for the result. In
74
- this example, the inject script is specified with a function literal. When
75
- using this format, the function is converted to a string for injection, so it
76
- should not reference any symbols not defined in the scope of the page under
77
- test.</p>
78
- <pre><code>driver.executeAsyncScript(function() {
79
- var callback &#61; arguments[arguments.length - 1];
80
- var xhr &#61; new XMLHttpRequest();
81
- xhr.open(&#34;GET&#34;, &#34;/resource/data.json&#34;, true);
82
- xhr.onreadystatechange &#61; function() {
83
- if (xhr.readyState &#61;&#61; 4) {
84
- callback(xhr.responseText);
85
- }
86
- }
87
- xhr.send(&#39;&#39;);
88
- }).then(function(str) {
89
- console.log(JSON.parse(str)[&#39;food&#39;]);
90
- });
91
- </code></pre>
92
- <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>
93
- <dt>var_args<code>...*</code><dd><p>The arguments to pass to the script.</p>
94
- </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
95
- scripts return value.</p>
96
- </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
97
- selected frame or window. The script fragment will be executed as the body
98
- of an anonymous function. If the script is provided as a function object,
99
- that function will be converted to a string for injection into the target
100
- window.</p>
101
- <p>Any arguments provided in addition to the script will be included as script
102
- arguments and may be referenced using the <code>arguments</code> object.
103
- Arguments may be a boolean, number, string, or <code>webdriver.WebElement</code>.
104
- Arrays and objects may also be used as script arguments as long as each item
105
- adheres to the types previously mentioned.</p>
106
- <p>The script may refer to any variables accessible from the current window.
107
- Furthermore, the script will execute in the window&#39;s context, thus
108
- <code>document</code> may be used to refer to the current document. Any local
109
- variables will not be available once the script has finished executing,
110
- though global variables will persist.</p>
111
- <p>If the script has a return value (i.e. if the script contains a return
112
- statement), then the following steps will be taken for resolving this
113
- functions return value:</p>
114
- <ul><li>For a HTML element, the value will resolve to a
115
- <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
116
- the rules above</li></ul>
117
- <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>
118
- <dt>var_args<code>...*</code><dd><p>The arguments to pass to the script.</p>
119
- </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
120
- scripts return value.</p>
121
- </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
122
- found, a <a href="enum_bot_ErrorCode.html#NO_SUCH_ELEMENT"><code>bot.ErrorCode.NO_SUCH_ELEMENT</code></a> result will be returned
123
- by the driver. Unlike other commands, this error cannot be suppressed. In
124
- other words, scheduling a command to find an element doubles as an assert
125
- that the element is present on the page. To test whether an element is
126
- present on the page, use <a href="module_selenium-webdriver_safari_class_Driver.html#isElementPresent"><code>#isElementPresent</code></a> instead.</p>
127
- <p>The search criteria for an element may be defined using one of the
128
- factories in the <a href="namespace_webdriver_By.html"><code>webdriver.By</code></a> namespace, or as a short-hand
129
- <a href="namespace_webdriver_By.html#By.Hash"><code>webdriver.By.Hash</code></a> object. For example, the following two statements
130
- are equivalent:</p>
131
- <pre><code>var e1 &#61; driver.findElement(By.id(&#39;foo&#39;));
132
- var e2 &#61; driver.findElement({id:&#39;foo&#39;});
133
- </code></pre>
134
- <p>You may also provide a custom locator function, which takes as input
135
- this WebDriver instance and returns a <a href="class_webdriver_WebElement.html"><code>webdriver.WebElement</code></a>, or a
136
- promise that will resolve to a WebElement. For example, to find the first
137
- visible link on a page, you could write:</p>
138
- <pre><code>var link &#61; driver.findElement(firstVisibleLink);
139
-
140
- function firstVisibleLink(driver) {
141
- var links &#61; driver.findElements(By.tagName(&#39;a&#39;));
142
- return webdriver.promise.filter(links, function(link) {
143
- return links.isDisplayed();
144
- }).then(function(visibleLinks) {
145
- return visibleLinks[0];
146
- });
147
- }
148
- </code></pre>
149
- <p>When running in the browser, a WebDriver cannot manipulate DOM elements
150
- directly; it may do so only through a <a href="class_webdriver_WebElement.html"><code>webdriver.WebElement</code></a> reference.
151
- This function may be used to generate a WebElement from a DOM element. A
152
- reference to the DOM element will be stored in a known location and this
153
- driver will attempt to retrieve it through <a href="module_selenium-webdriver_safari_class_Driver.html#executeScript"><code>#executeScript</code></a>. If the
154
- element cannot be found (eg, it belongs to a different document than the
155
- one this instance is currently focused on), a
156
- <a href="enum_bot_ErrorCode.html#NO_SUCH_ELEMENT"><code>bot.ErrorCode.NO_SUCH_ELEMENT</code></a> error will be returned.</p>
157
- <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
158
- locator to use.</p>
159
- </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
160
- commands against the located element. If the element is not found, the
161
- element will be invalidated and all scheduled commands aborted.</p>
162
- </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>
163
- <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
164
- strategy to use when searching for the element.</p>
165
- </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
166
- promise that will resolve to an array of WebElements.</p>
167
- </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>
168
- <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>
169
- </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
170
- when the document has finished loading.</p>
171
- </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>
172
- <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
173
- be resolved with an array of window handles.</p>
174
- </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
175
- that will resolve with the this instance&#39;s capabilities.</p>
176
- </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>
177
- <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
178
- resolved with the current URL.</p>
179
- </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
180
- returned is a representation of the underlying DOM: do not expect it to be
181
- formatted or escaped in the same way as the response sent from the web
182
- server.</p>
183
- <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
184
- resolved with the current page source.</p>
185
- </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
186
- client&#39;s session.</p>
187
- </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>
188
- <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
189
- resolved with the current page&#39;s title.</p>
190
- </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>
191
- <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
192
- resolved with the current window handle.</p>
193
- </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>
194
- <p>If given a DOM element, this function will check if it belongs to the
195
- document the driver is currently focused on. Otherwise, the function will
196
- test if at least one element can be found with the given search criteria.</p>
197
- <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
198
- DOM element to be located by the server.</p>
199
- </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
200
- with whether the element is present on the page.</p>
201
- </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
202
- instance.</p>
203
- </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
204
- instance.</p>
205
- </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
206
- instance will be invalidated and may no longer be used to issue commands
207
- against the browser.</p>
208
- <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
209
- when the command has completed.</p>
210
- </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
211
- <code>webdriver.CommandExecutor</code>.</p>
212
- <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>
213
- <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>
214
- </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
215
- with the command result.</p>
216
- </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/lib/webdriver/webdriver.js.src.html#l407">code »</a></span></h3><p>Sets the <a href="class_webdriver_FileDetector.html">file detector</a> that should be
217
- used with this instance.</p>
218
- <p><b>Defined by: </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>
219
- </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>
220
- <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>
221
- </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
222
- when the sleep has finished.</p>
223
- </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
224
- this instance.</p>
225
- </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
226
- return a screenshot of the following, in order of preference:</p>
227
- <ol><li>Entire page
228
- </li><li>Current window
229
- </li><li>Visible portion of the current frame
230
- </li><li>The screenshot of the entire display containing the browser
231
- </li></ol>
232
- <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
233
- resolved to the screenshot as a base-64 encoded PNG.</p>
234
- </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
235
- scheduled for execution until <a href="class_webdriver_TouchSequence.html#perform"><code>webdriver.TouchSequence#perform</code></a> is
236
- called. Example:</p>
237
- <pre><code>driver.touchActions().
238
- tap(element1).
239
- doubleTap(element2).
240
- perform();
241
- </code></pre>
242
- <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>
243
- </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
244
- specified by a <a href="class_webdriver_until_Condition.html"><code>webdriver.until.Condition</code></a>, as a custom function, or
245
- as a <a href="class_webdriver_promise_Promise.html"><code>webdriver.promise.Promise</code></a>.</p>
246
- <p>For a <a href="class_webdriver_until_Condition.html"><code>webdriver.until.Condition</code></a> or function, the wait will repeatedly
247
- evaluate the condition until it returns a truthy value. If any errors occur
248
- while evaluating the condition, they will be allowed to propagate. In the
249
- event a condition returns a <a href="class_webdriver_promise_Promise.html"><code>promise</code></a>, the
250
- polling loop will wait for it to be resolved and use the resolved value for
251
- whether the condition has been satisified. Note the resolution time for
252
- a promise is factored into whether a wait has timed out.</p>
253
- <p><em>Example:</em> waiting up to 10 seconds for an element to be present and visible
254
- on the page.</p>
255
- <pre><code>var button &#61; driver.wait(until.elementLocated(By.id(&#39;foo&#39;)), 10000);
256
- button.click();
257
- </code></pre>
258
- <p>This function may also be used to block the command flow on the resolution
259
- of a <a href="class_webdriver_promise_Promise.html"><code>promise</code></a>. When given a promise, the
260
- command will simply wait for its resolution before completing. A timeout may
261
- be provided to fail the command if the promise does not resolve before the
262
- timeout expires.</p>
263
- <p><em>Example:</em> Suppose you have a function, <code>startTestServer</code>, that returns a
264
- promise for when a server is ready for requests. You can block a <code>WebDriver</code>
265
- client on this promise with:</p>
266
- <pre><code>var started &#61; startTestServer();
267
- driver.wait(started, 5 * 1000, &#39;Server should start within 5 seconds&#39;);
268
- driver.get(getServerUrl());
269
- </code></pre>
270
- <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
271
- wait on, defined as a promise, condition object, or a function to
272
- evaluate as a condition.</p>
273
- <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>
274
- <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
275
- out.</p>
276
- </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
277
- with the first truthy value returned by the condition function, or
278
- rejected if the condition times out.</p>
279
- </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,23 +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>Options</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_safari.html">selenium-webdriver/safari</a></div><div class="codelink"><a href="source/safari.js.src.html#l538">View Source</a></div><h1>class Options</h1><pre class="inheritance"><a href="class_webdriver_Serializable.html">webdriver.Serializable</a>
2
- &#x2514; Options</pre><p>Configuration options specific to the <a href="module_selenium-webdriver_safari_class_Driver.html"><code>SafariDriver</code></a>.</p>
3
- <h3>new Options()</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dd>None.</dl></div></div><h2>Instance Methods</h2><div id="serialize" class="function"><div><h3>serialize()<span class="codelink"><a href="source/safari.js.src.html#l499">code »</a></span></h3><p>Converts this instance to its JSON wire protocol representation. Note this
4
- function is an implementation detail not intended for general use.</p>
5
- <p><b>Overrides: </b><a href="class_webdriver_Serializable.html#serialize">webdriver.Serializable</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/Object">Object</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, *&gt;</code><dd><p>The JSON wire protocol representation of this
6
- instance.</p>
7
- </dl></div></div></div></div><hr class="fn-sep"><div id="setCleanSession" class="function"><div><h3>setCleanSession(<wbr>clean)<span class="codelink"><a href="source/safari.js.src.html#l454">code »</a></span></h3><p>Sets whether to force Safari to start with a clean session. Enabling this
8
- option will cause all global browser data to be deleted.</p>
9
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>clean<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether to make sure the session has no cookies,
10
- cache entries, local storage, or databases.</p>
11
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_safari_class_Options.html">Options</a></code><dd><p>A self reference.</p>
12
- </dl></div></div></div></div><hr class="fn-sep"><div id="setLoggingPrefs" class="function"><div><h3>setLoggingPrefs(<wbr>prefs)<span class="codelink"><a href="source/safari.js.src.html#l468">code »</a></span></h3><p>Sets the logging preferences for the new session.</p>
13
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>prefs<code><a href="class_webdriver_logging_Preferences.html">webdriver.logging.Preferences</a></code><dd><p>The logging preferences.</p>
14
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_safari_class_Options.html">Options</a></code><dd><p>A self reference.</p>
15
- </dl></div></div></div></div><hr class="fn-sep"><div id="toCapabilities" class="function"><div><h3>toCapabilities(<wbr>opt_capabilities)<span class="codelink"><a href="source/safari.js.src.html#l480">code »</a></span></h3><p>Converts this options instance to a <a href="class_webdriver_Capabilities.html"><code>webdriver.Capabilities</code></a> object.</p>
16
- <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 capabilities to merge
17
- these options into, if any.</p>
18
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_Capabilities.html">webdriver.Capabilities</a></code><dd><p>The capabilities.</p>
19
- </dl></div></div></div></div><h2>Static Functions</h2><div id="Options.fromCapabilities" class="function"><div><h3>Options.fromCapabilities(<wbr>capabilities)<span class="codelink"><a href="source/safari.js.src.html#l428">code »</a></span></h3><p>Extracts the SafariDriver specific options from the given capabilities
20
- object.</p>
21
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>capabilities<code><a href="module_selenium-webdriver_class_Capabilities.html">Capabilities</a></code><dd><p>The capabilities object.</p>
22
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="module_selenium-webdriver_safari_class_Options.html">Options</a></code><dd><p>The ChromeDriver options.</p>
23
- </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,74 +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/testing</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/testing/index.js.src.html#l69">View Source</a></div><h1>module selenium-webdriver/testing</h1><p>Provides wrappers around the following global functions from
2
- <a href="https://github.com/mochajs/mocha">Mocha&#39;s BDD interface</a>:</p>
3
- <ul><li>after</li><li>afterEach</li><li>before</li><li>beforeEach</li><li>it</li><li>it.only</li><li>it.skip</li><li>xit</li></ul>
4
- <p>The provided wrappers leverage the <a href="class_webdriver_promise_ControlFlow.html"><code>webdriver.promise.ControlFlow</code></a>
5
- to simplify writing asynchronous tests:</p>
6
- <pre><code>var By &#61; require(&#39;selenium-webdriver&#39;).By,
7
- until &#61; require(&#39;selenium-webdriver&#39;).until,
8
- firefox &#61; require(&#39;selenium-webdriver/firefox&#39;),
9
- test &#61; require(&#39;selenium-webdriver/testing&#39;);
10
-
11
- test.describe(&#39;Google Search&#39;, function() {
12
- var driver;
13
-
14
- test.before(function() {
15
- driver &#61; new firefox.Driver();
16
- });
17
-
18
- test.after(function() {
19
- driver.quit();
20
- });
21
-
22
- test.it(&#39;should append query to title&#39;, function() {
23
- driver.get(&#39;http://www.google.com/ncr&#39;);
24
- driver.findElement(By.name(&#39;q&#39;)).sendKeys(&#39;webdriver&#39;);
25
- driver.findElement(By.name(&#39;btnG&#39;)).click();
26
- driver.wait(until.titleIs(&#39;webdriver - Google Search&#39;), 1000);
27
- });
28
- });
29
- </code></pre>
30
- <p>You may conditionally suppress a test function using the exported
31
- &#34;ignore&#34; function. If the provided predicate returns true, the attached
32
- test case will be skipped:</p>
33
- <pre><code>test.ignore(maybe()).it(&#39;is flaky&#39;, function() {
34
- if (Math.random() &lt; 0.5) throw Error();
35
- });
36
-
37
- function maybe() { return Math.random() &lt; 0.5; }
38
- </code></pre>
39
- <h2>Functions</h2><div id="after" class="function"><div><h3>after(<wbr>fn)<span class="codelink"><a href="source/testing/index.js.src.html#l213">code »</a></span></h3><p>Register a function to call after the current suite finishes.</p>
40
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>fn<code>function(): ?</code><dd><p>.</p>
41
- </dl></div></div></div></div><hr class="fn-sep"><div id="afterEach" class="function"><div><h3>afterEach(<wbr>fn)<span class="codelink"><a href="source/testing/index.js.src.html#l219">code »</a></span></h3><p>Register a function to call after each test in a suite.</p>
42
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>fn<code>function(): ?</code><dd><p>.</p>
43
- </dl></div></div></div></div><hr class="fn-sep"><div id="before" class="function"><div><h3>before(<wbr>fn)<span class="codelink"><a href="source/testing/index.js.src.html#l225">code »</a></span></h3><p>Register a function to call before the current suite starts.</p>
44
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>fn<code>function(): ?</code><dd><p>.</p>
45
- </dl></div></div></div></div><hr class="fn-sep"><div id="beforeEach" class="function"><div><h3>beforeEach(<wbr>fn)<span class="codelink"><a href="source/testing/index.js.src.html#l231">code »</a></span></h3><p>Register a function to call before each test in a suite.</p>
46
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>fn<code>function(): ?</code><dd><p>.</p>
47
- </dl></div></div></div></div><hr class="fn-sep"><div id="describe" class="function"><div><h3>describe(<wbr>name, fn)<span class="codelink"><a href="source/testing/index.js.src.html#l198">code »</a></span></h3><p>Registers a new test suite.</p>
48
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>name<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The suite name.</p>
49
- <dt>fn<code>function(): ?=</code><dd><p>The suite function, or <code>undefined</code> to define
50
- a pending test suite.</p>
51
- </dl></div></div></div></div><hr class="fn-sep"><div id="ignore" class="function"><div><h3>ignore(<wbr>predicateFn)<span class="codelink"><a href="source/testing/index.js.src.html#l258">code »</a></span></h3><p>Ignores the test chained to this function if the provided predicate returns
52
- true.</p>
53
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>predicateFn<code>function(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>A predicate to call to determine
54
- if the test should be suppressed. This function MUST be synchronous.</p>
55
- </dl></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/Object">Object</a></code><dd><p>An object with wrapped versions of <a href="module_selenium-webdriver_testing.html#it"><code>#it()</code></a> and
56
- <a href="module_selenium-webdriver_testing.html#describe"><code>#describe()</code></a> that ignore tests as indicated by the predicate.</p>
57
- </dl></div></div></div></div><hr class="fn-sep"><div id="iit" class="function"><div><h3>iit(<wbr>name, fn)<span class="codelink"><a href="source/testing/index.js.src.html#l248">code »</a></span></h3><p>An alias for <a href="module_selenium-webdriver_testing.html#it"><code>#it()</code></a> that flags the test as the only one that should
58
- be run within the current suite.</p>
59
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>name<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The test name.</p>
60
- <dt>fn<code>function(): ?=</code><dd><p>The test function, or <code>undefined</code> to define
61
- a pending test case.</p>
62
- </dl></div></div></div></div><hr class="fn-sep"><div id="it" class="function"><div><h3>it(<wbr>name, fn)<span class="codelink"><a href="source/testing/index.js.src.html#l239">code »</a></span></h3><p>Add a test to the current suite.</p>
63
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>name<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The test name.</p>
64
- <dt>fn<code>function(): ?=</code><dd><p>The test function, or <code>undefined</code> to define
65
- a pending test case.</p>
66
- </dl></div></div></div></div><hr class="fn-sep"><div id="xdescribe" class="function"><div><h3>xdescribe(<wbr>name, fn)<span class="codelink"><a href="source/testing/index.js.src.html#l206">code »</a></span></h3><p>Defines a suppressed test suite.</p>
67
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>name<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The suite name.</p>
68
- <dt>fn<code>function(): ?=</code><dd><p>The suite function, or <code>undefined</code> to define
69
- a pending test suite.</p>
70
- </dl></div></div></div></div><hr class="fn-sep"><div id="xit" class="function"><div><h3>xit(<wbr>name, fn)<span class="codelink"><a href="source/testing/index.js.src.html#l256">code »</a></span></h3><p>Adds a test to the current suite while suppressing it so it is not run.</p>
71
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>name<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The test name.</p>
72
- <dt>fn<code>function(): ?=</code><dd><p>The test function, or <code>undefined</code> to define
73
- a pending test case.</p>
74
- </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,9 +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/testing/assert</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/testing/assert.js.src.html#l47">View Source</a></div><h1>module selenium-webdriver/testing/assert</h1><p>Creates a new assertion.</p>
2
- <h2>assert(<wbr>value)</h2><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>value<code>*</code><dd><p>The value to perform an assertion on.</p>
3
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_testing_Assertion.html">webdriver.testing.Assertion</a></code><dd><p>The new assertion.</p>
4
- </dl></div></div><h2>Functions</h2><div id="register" class="function"><div><h3>register(<wbr>name, matcherTemplate)<span class="codelink"><a href="source/testing/assert.js.src.html#l61">code »</a></span></h3><p>Registers a new assertion to expose from the
5
- <a href="class_webdriver_testing_Assertion.html"><code>webdriver.testing.Assertion</code></a> prototype.</p>
6
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>name<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The assertion name.</p>
7
- <dt>matcherTemplate<code>(function(new: goog.labs.testing.Matcher, *): ?|{describe: function(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, matches: function(*): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>})</code><dd><p>Either the
8
- matcher constructor to use, or an object literal defining a matcher.</p>
9
- </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,4 +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>bot</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/lib/atoms/error.js.src.html#l23">View Source</a></div><h1>namespace bot</h1><h2>Types</h2><dl><dt><a href="class_bot_Error.html">Error</a><dd><p>Represents an error returned from a WebDriver command request.</p>
2
- <dt><a href="enum_bot_ErrorCode.html">ErrorCode</a><dd><p>Error codes from the Selenium WebDriver protocol:
3
- https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#response-status-codes</p>
4
- </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,20 +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>bot.json</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/lib/atoms/json.js.src.html#l23">View Source</a></div><h1>namespace bot.json</h1><h2>Functions</h2><div id="parse" class="function"><div><h3>parse(<wbr>jsonStr)<span class="codelink"><a href="source/lib/atoms/json.js.src.html#l79">code »</a></span></h3><p>Parses a JSON string and returns the result.</p>
2
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>jsonStr<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The string to parse.</p>
3
- </dl></div><div class="fn-details"><div><b>Returns</b></div><p>The JSON object.</p>
4
- </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 input string is an invalid JSON string.</p>
5
- </dl></div></div></div></div><hr class="fn-sep"><div id="stringify" class="function"><div><h3>stringify(<wbr>jsonObj, opt_replacer)<span class="codelink"><a href="source/lib/atoms/json.js.src.html#l69">code »</a></span></h3><p>Converts a JSON object to its string representation.</p>
6
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>jsonObj<code>*</code><dd><p>The input object.</p>
7
- <dt>opt_replacer<code>?function(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, *): *=</code><dd><p>A replacer function called
8
- for each (key, value) pair that determines how the value should be
9
- serialized. By default, this just returns the value and allows default
10
- serialization to kick in.</p>
11
- </dl></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/String">string</a></code><dd><p>A JSON string representation of the input object.</p>
12
- </dl></div></div></div></div><h2>Compiler Constants</h2><div id="NATIVE_JSON" class="property"><dl><dt><a href="source/lib/atoms/json.js.src.html#l42">NATIVE_JSON</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>NATIVE_JSON indicates whether the code should rely on the
13
- native <code>JSON</code> functions, if available.</p>
14
- <p>The JSON functions can be defined by external libraries like Prototype
15
- and setting this flag to false forces the use of Closure&#39;s goog.json
16
- implementation.
17
- </p><p>If your JavaScript can be loaded by a third_party site and you are wary
18
- about relying on the native functions, specify
19
- &#34;--define bot.json.NATIVE_JSON&#61;false&#34; to the Closure compiler.
20
- </p></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,18 +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>bot.response</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/lib/atoms/response.js.src.html#l23">View Source</a></div><h1>namespace bot.response</h1><h2>Functions</h2><div id="checkResponse" class="function"><div><h3>checkResponse(<wbr>responseObj)<span class="codelink"><a href="source/lib/atoms/response.js.src.html#l95">code »</a></span></h3><p>Checks that a response object does not specify an error as defined by the
2
- WebDriver wire protocol. If the response object defines an error, it will
3
- be thrown. Otherwise, the response will be returned as is.</p>
4
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>responseObj<code>{status: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, value: *}</code><dd><p>The response object to
5
- check.</p>
6
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code>{status: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, value: *}</code><dd><p>The checked response object.</p>
7
- </dl></div><div class="fn-details"><div><b>Throws</b></div><dl><dt><code><a href="class_bot_Error.html">bot.Error</a></code><dd><p>If the response describes an error.</p>
8
- </dl></div></div></div></div><hr class="fn-sep"><div id="createErrorResponse" class="function"><div><h3>createErrorResponse(<wbr>error)<span class="codelink"><a href="source/lib/atoms/response.js.src.html#l69">code »</a></span></h3><p>Converts an error value into its JSON representation as defined by the
9
- WebDriver wire protocol.</p>
10
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>error<code>*</code><dd><p>The error value to convert.</p>
11
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code>{status: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, value: *}</code><dd><p>The new response object.</p>
12
- </dl></div></div></div></div><hr class="fn-sep"><div id="createResponse" class="function"><div><h3>createResponse(<wbr>value)<span class="codelink"><a href="source/lib/atoms/response.js.src.html#l52">code »</a></span></h3><p>Creates a new success response object with the provided value.</p>
13
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>value<code>*</code><dd><p>The response value.</p>
14
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code>{status: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, value: *}</code><dd><p>The new response object.</p>
15
- </dl></div></div></div></div><hr class="fn-sep"><div id="isResponseObject" class="function"><div><h3>isResponseObject(<wbr>value)<span class="codelink"><a href="source/lib/atoms/response.js.src.html#l42">code »</a></span></h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>value<code>*</code><dd><p>The value to test.</p>
16
- </dl></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 given value is a response object.</p>
17
- </dl></div></div></div></div><h2>Type Definitions</h2><div id="response.ResponseObject" class="property"><dl><dt><a href="source/lib/atoms/response.js.src.html#l35">response.ResponseObject</a><code>{status: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, value: *}</code><dd><p>Type definition for a response object, as defined by the JSON wire protocol.</p>
18
- </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>