selenium-webdriver 2.48.2 → 2.53.3

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 (534) hide show
  1. package/CHANGES.md +116 -0
  2. package/NOTICE +1 -1
  3. package/README.md +59 -9
  4. package/builder.js +375 -358
  5. package/chrome.js +549 -586
  6. package/edge.js +378 -0
  7. package/error.js +9 -6
  8. package/example/google_search.js +1 -1
  9. package/example/google_search_generator.js +2 -4
  10. package/example/logging.js +6 -2
  11. package/example/sample.js +21 -0
  12. package/executors.js +11 -27
  13. package/firefox/binary.js +149 -98
  14. package/firefox/extension.js +15 -19
  15. package/firefox/index.js +256 -163
  16. package/firefox/profile.js +223 -243
  17. package/http/index.js +487 -81
  18. package/http/util.js +40 -36
  19. package/ie.js +288 -309
  20. package/index.js +34 -125
  21. package/io/exec.js +58 -39
  22. package/io/index.js +72 -60
  23. package/lib/README +4 -0
  24. package/lib/actions.js +596 -0
  25. package/lib/by.js +277 -0
  26. package/lib/capabilities.js +450 -0
  27. package/lib/{webdriver/command.js → command.js} +91 -72
  28. package/lib/{webdriver/button.js → devmode.js} +13 -8
  29. package/lib/error.js +690 -0
  30. package/lib/events.js +212 -0
  31. package/lib/firefox/amd64/libnoblur64.so +0 -0
  32. package/lib/firefox/i386/libnoblur.so +0 -0
  33. package/lib/firefox/webdriver.json +5 -1
  34. package/lib/firefox/webdriver.xpi +0 -0
  35. package/lib/{webdriver/key.js → input.js} +84 -2
  36. package/lib/logging.js +670 -0
  37. package/lib/{webdriver/promise.js → promise.js} +817 -644
  38. package/lib/safari/client.js +266 -214
  39. package/lib/session.js +80 -0
  40. package/lib/{webdriver/serializable.js → symbols.js} +16 -19
  41. package/lib/test/build.js +4 -4
  42. package/lib/test/data/click_tests/html5_submit_buttons.html +2 -1
  43. package/lib/test/data/click_tests/overlapping_elements.html +15 -4
  44. package/lib/test/data/click_tests/partially_overlapping_elements.html +124 -0
  45. package/lib/test/data/click_tests/wrapped_overlapping_elements.html +13 -0
  46. package/lib/test/data/hidden_partially.html +45 -0
  47. package/lib/test/data/readOnlyPage.html +1 -1
  48. package/lib/test/data/selectPage.html +18 -2
  49. package/lib/test/fileserver.js +3 -4
  50. package/lib/test/index.js +7 -3
  51. package/lib/test/resources.js +1 -1
  52. package/lib/until.js +376 -0
  53. package/lib/webdriver.js +2440 -0
  54. package/net/index.js +4 -0
  55. package/net/portprober.js +16 -12
  56. package/opera.js +295 -314
  57. package/package.json +6 -5
  58. package/phantomjs.js +144 -147
  59. package/proxy.js +10 -6
  60. package/remote/index.js +289 -238
  61. package/safari.js +326 -311
  62. package/test/chrome/options_test.js +11 -9
  63. package/test/element_finding_test.js +51 -13
  64. package/test/execute_script_test.js +17 -3
  65. package/test/firefox/firefox_test.js +0 -32
  66. package/test/http/http_test.js +671 -61
  67. package/test/http/util_test.js +25 -23
  68. package/test/io_test.js +67 -1
  69. package/test/lib/by_test.js +139 -0
  70. package/test/lib/capabilities_test.js +111 -0
  71. package/test/lib/error_test.js +325 -0
  72. package/test/lib/events_test.js +177 -0
  73. package/test/lib/logging_test.js +272 -0
  74. package/test/{promise_aplus_test.js → lib/promise_aplus_test.js} +4 -13
  75. package/test/lib/promise_error_test.js +808 -0
  76. package/test/lib/promise_flow_test.js +2282 -0
  77. package/test/lib/promise_generator_test.js +308 -0
  78. package/test/lib/promise_test.js +996 -0
  79. package/test/lib/testutil.js +90 -0
  80. package/test/lib/until_test.js +400 -0
  81. package/test/lib/webdriver_test.js +2157 -0
  82. package/test/page_loading_test.js +7 -9
  83. package/test/remote_test.js +50 -3
  84. package/test/session_test.js +53 -0
  85. package/test/stale_element_test.js +2 -2
  86. package/test/testing/assert_test.js +374 -0
  87. package/test/testing/index_test.js +9 -11
  88. package/testing/assert.js +334 -17
  89. package/testing/index.js +12 -2
  90. package/_base.js +0 -200
  91. package/docs/Changes.html +0 -356
  92. package/docs/class_bot_Error.html +0 -15
  93. package/docs/class_webdriver_ActionSequence.html +0 -115
  94. package/docs/class_webdriver_Alert.html +0 -24
  95. package/docs/class_webdriver_AlertPromise.html +0 -92
  96. package/docs/class_webdriver_Capabilities.html +0 -60
  97. package/docs/class_webdriver_Command.html +0 -15
  98. package/docs/class_webdriver_EventEmitter.html +0 -35
  99. package/docs/class_webdriver_FileDetector.html +0 -21
  100. package/docs/class_webdriver_Locator.html +0 -12
  101. package/docs/class_webdriver_Serializable.html +0 -9
  102. package/docs/class_webdriver_Session.html +0 -13
  103. package/docs/class_webdriver_TouchSequence.html +0 -49
  104. package/docs/class_webdriver_UnhandledAlertError.html +0 -18
  105. package/docs/class_webdriver_WebDriver.html +0 -313
  106. package/docs/class_webdriver_WebDriver_Logs.html +0 -15
  107. package/docs/class_webdriver_WebDriver_Navigation.html +0 -16
  108. package/docs/class_webdriver_WebDriver_Options.html +0 -41
  109. package/docs/class_webdriver_WebDriver_TargetLocator.html +0 -38
  110. package/docs/class_webdriver_WebDriver_Timeouts.html +0 -29
  111. package/docs/class_webdriver_WebDriver_Window.html +0 -27
  112. package/docs/class_webdriver_WebElement.html +0 -223
  113. package/docs/class_webdriver_WebElementPromise.html +0 -274
  114. package/docs/class_webdriver_http_Executor.html +0 -22
  115. package/docs/class_webdriver_http_Request.html +0 -12
  116. package/docs/class_webdriver_http_Response.html +0 -13
  117. package/docs/class_webdriver_logging_Entry.html +0 -15
  118. package/docs/class_webdriver_logging_Level.html +0 -55
  119. package/docs/class_webdriver_logging_LogRecord.html +0 -45
  120. package/docs/class_webdriver_logging_Logger.html +0 -119
  121. package/docs/class_webdriver_logging_Preferences.html +0 -8
  122. package/docs/class_webdriver_promise_CancellationError.html +0 -17
  123. package/docs/class_webdriver_promise_ControlFlow.html +0 -153
  124. package/docs/class_webdriver_promise_Deferred.html +0 -84
  125. package/docs/class_webdriver_promise_MultipleUnhandledRejectionError.html +0 -14
  126. package/docs/class_webdriver_promise_Promise.html +0 -75
  127. package/docs/class_webdriver_stacktrace_Frame.html +0 -20
  128. package/docs/class_webdriver_stacktrace_Snapshot.html +0 -6
  129. package/docs/class_webdriver_testing_Assertion.html +0 -99
  130. package/docs/class_webdriver_testing_Assertion_DelegatingMatcher_.html +0 -13
  131. package/docs/class_webdriver_testing_ContainsMatcher.html +0 -11
  132. package/docs/class_webdriver_testing_NegatedAssertion.html +0 -97
  133. package/docs/class_webdriver_until_Condition.html +0 -7
  134. package/docs/dossier.css +0 -1
  135. package/docs/dossier.js +0 -86
  136. package/docs/enum_bot_ErrorCode.html +0 -3
  137. package/docs/enum_bot_Error_State.html +0 -2
  138. package/docs/enum_webdriver_Browser.html +0 -2
  139. package/docs/enum_webdriver_Button.html +0 -2
  140. package/docs/enum_webdriver_Capability.html +0 -33
  141. package/docs/enum_webdriver_CommandName.html +0 -3
  142. package/docs/enum_webdriver_Key.html +0 -12
  143. package/docs/enum_webdriver_logging_Type.html +0 -6
  144. package/docs/enum_webdriver_promise_ControlFlow_EventType.html +0 -9
  145. package/docs/index.html +0 -125
  146. package/docs/interface_webdriver_CommandExecutor.html +0 -9
  147. package/docs/interface_webdriver_http_Client.html +0 -10
  148. package/docs/interface_webdriver_promise_Thenable.html +0 -77
  149. package/docs/module_selenium-webdriver.html +0 -23
  150. package/docs/module_selenium-webdriver__base.html +0 -23
  151. package/docs/module_selenium-webdriver__base_class_Context.html +0 -5
  152. package/docs/module_selenium-webdriver_builder.html +0 -2
  153. package/docs/module_selenium-webdriver_builder_class_Builder.html +0 -138
  154. package/docs/module_selenium-webdriver_chrome.html +0 -90
  155. package/docs/module_selenium-webdriver_chrome_class_Driver.html +0 -280
  156. package/docs/module_selenium-webdriver_chrome_class_Options.html +0 -127
  157. package/docs/module_selenium-webdriver_chrome_class_ServiceBuilder.html +0 -46
  158. package/docs/module_selenium-webdriver_class_ActionSequence.html +0 -115
  159. package/docs/module_selenium-webdriver_class_Builder.html +0 -138
  160. package/docs/module_selenium-webdriver_class_Capabilities.html +0 -60
  161. package/docs/module_selenium-webdriver_class_Command.html +0 -15
  162. package/docs/module_selenium-webdriver_class_EventEmitter.html +0 -35
  163. package/docs/module_selenium-webdriver_class_FileDetector.html +0 -21
  164. package/docs/module_selenium-webdriver_class_Serializable.html +0 -9
  165. package/docs/module_selenium-webdriver_class_Session.html +0 -13
  166. package/docs/module_selenium-webdriver_class_WebDriver.html +0 -313
  167. package/docs/module_selenium-webdriver_class_WebElement.html +0 -223
  168. package/docs/module_selenium-webdriver_class_WebElementPromise.html +0 -274
  169. package/docs/module_selenium-webdriver_enum_Browser.html +0 -2
  170. package/docs/module_selenium-webdriver_enum_Button.html +0 -2
  171. package/docs/module_selenium-webdriver_enum_Capability.html +0 -33
  172. package/docs/module_selenium-webdriver_enum_CommandName.html +0 -3
  173. package/docs/module_selenium-webdriver_enum_Key.html +0 -12
  174. package/docs/module_selenium-webdriver_error.html +0 -4
  175. package/docs/module_selenium-webdriver_error_class_Error.html +0 -15
  176. package/docs/module_selenium-webdriver_error_enum_ErrorCode.html +0 -3
  177. package/docs/module_selenium-webdriver_executors.html +0 -10
  178. package/docs/module_selenium-webdriver_executors_class_DeferredExecutor.html +0 -12
  179. package/docs/module_selenium-webdriver_firefox.html +0 -68
  180. package/docs/module_selenium-webdriver_firefox_binary.html +0 -5
  181. package/docs/module_selenium-webdriver_firefox_binary_class_Binary.html +0 -20
  182. package/docs/module_selenium-webdriver_firefox_class_Binary.html +0 -20
  183. package/docs/module_selenium-webdriver_firefox_class_Driver.html +0 -276
  184. package/docs/module_selenium-webdriver_firefox_class_Options.html +0 -19
  185. package/docs/module_selenium-webdriver_firefox_class_Profile.html +0 -50
  186. package/docs/module_selenium-webdriver_firefox_extension.html +0 -8
  187. package/docs/module_selenium-webdriver_firefox_profile.html +0 -13
  188. package/docs/module_selenium-webdriver_firefox_profile_class_Profile.html +0 -50
  189. package/docs/module_selenium-webdriver_http.html +0 -9
  190. package/docs/module_selenium-webdriver_http_class_Executor.html +0 -22
  191. package/docs/module_selenium-webdriver_http_class_HttpClient.html +0 -16
  192. package/docs/module_selenium-webdriver_http_class_Request.html +0 -12
  193. package/docs/module_selenium-webdriver_http_class_Response.html +0 -13
  194. package/docs/module_selenium-webdriver_http_util.html +0 -17
  195. package/docs/module_selenium-webdriver_ie.html +0 -11
  196. package/docs/module_selenium-webdriver_ie_class_Driver.html +0 -274
  197. package/docs/module_selenium-webdriver_ie_class_Options.html +0 -89
  198. package/docs/module_selenium-webdriver_ie_enum_Level.html +0 -1
  199. package/docs/module_selenium-webdriver_io.html +0 -37
  200. package/docs/module_selenium-webdriver_io_exec.html +0 -6
  201. package/docs/module_selenium-webdriver_namespace_By.html +0 -56
  202. package/docs/module_selenium-webdriver_namespace_error.html +0 -4
  203. package/docs/module_selenium-webdriver_namespace_logging.html +0 -18
  204. package/docs/module_selenium-webdriver_namespace_promise.html +0 -163
  205. package/docs/module_selenium-webdriver_namespace_stacktrace.html +0 -17
  206. package/docs/module_selenium-webdriver_namespace_until.html +0 -82
  207. package/docs/module_selenium-webdriver_net.html +0 -7
  208. package/docs/module_selenium-webdriver_net_portprober.html +0 -12
  209. package/docs/module_selenium-webdriver_opera.html +0 -62
  210. package/docs/module_selenium-webdriver_opera_class_Driver.html +0 -276
  211. package/docs/module_selenium-webdriver_opera_class_Options.html +0 -44
  212. package/docs/module_selenium-webdriver_opera_class_ServiceBuilder.html +0 -35
  213. package/docs/module_selenium-webdriver_phantomjs.html +0 -2
  214. package/docs/module_selenium-webdriver_phantomjs_class_Driver.html +0 -299
  215. package/docs/module_selenium-webdriver_proxy.html +0 -28
  216. package/docs/module_selenium-webdriver_remote.html +0 -8
  217. package/docs/module_selenium-webdriver_remote_class_DriverService.html +0 -32
  218. package/docs/module_selenium-webdriver_remote_class_FileDetector.html +0 -22
  219. package/docs/module_selenium-webdriver_remote_class_SeleniumServer.html +0 -41
  220. package/docs/module_selenium-webdriver_safari.html +0 -9
  221. package/docs/module_selenium-webdriver_safari_class_Driver.html +0 -279
  222. package/docs/module_selenium-webdriver_safari_class_Options.html +0 -23
  223. package/docs/module_selenium-webdriver_testing.html +0 -74
  224. package/docs/module_selenium-webdriver_testing_assert.html +0 -9
  225. package/docs/namespace_bot.html +0 -4
  226. package/docs/namespace_bot_json.html +0 -20
  227. package/docs/namespace_bot_response.html +0 -18
  228. package/docs/namespace_bot_userAgent.html +0 -33
  229. package/docs/namespace_webdriver.html +0 -30
  230. package/docs/namespace_webdriver_By.html +0 -56
  231. package/docs/namespace_webdriver_http.html +0 -6
  232. package/docs/namespace_webdriver_logging.html +0 -70
  233. package/docs/namespace_webdriver_promise.html +0 -688
  234. package/docs/namespace_webdriver_stacktrace.html +0 -17
  235. package/docs/namespace_webdriver_testing.html +0 -7
  236. package/docs/namespace_webdriver_testing_assert.html +0 -9
  237. package/docs/namespace_webdriver_testing_asserts.html +0 -18
  238. package/docs/namespace_webdriver_until.html +0 -82
  239. package/docs/source/_base.js.src.html +0 -1
  240. package/docs/source/builder.js.src.html +0 -1
  241. package/docs/source/chrome.js.src.html +0 -1
  242. package/docs/source/error.js.src.html +0 -1
  243. package/docs/source/executors.js.src.html +0 -1
  244. package/docs/source/firefox/binary.js.src.html +0 -1
  245. package/docs/source/firefox/extension.js.src.html +0 -1
  246. package/docs/source/firefox/index.js.src.html +0 -1
  247. package/docs/source/firefox/profile.js.src.html +0 -1
  248. package/docs/source/http/index.js.src.html +0 -1
  249. package/docs/source/http/util.js.src.html +0 -1
  250. package/docs/source/ie.js.src.html +0 -1
  251. package/docs/source/index.js.src.html +0 -1
  252. package/docs/source/io/exec.js.src.html +0 -1
  253. package/docs/source/io/index.js.src.html +0 -1
  254. package/docs/source/lib/atoms/error.js.src.html +0 -1
  255. package/docs/source/lib/atoms/json.js.src.html +0 -1
  256. package/docs/source/lib/atoms/response.js.src.html +0 -1
  257. package/docs/source/lib/atoms/userAgent.js.src.html +0 -1
  258. package/docs/source/lib/goog/array/array.js.src.html +0 -1
  259. package/docs/source/lib/goog/asserts/asserts.js.src.html +0 -1
  260. package/docs/source/lib/goog/async/freelist.js.src.html +0 -1
  261. package/docs/source/lib/goog/async/nexttick.js.src.html +0 -1
  262. package/docs/source/lib/goog/async/run.js.src.html +0 -1
  263. package/docs/source/lib/goog/async/workqueue.js.src.html +0 -1
  264. package/docs/source/lib/goog/base.js.src.html +0 -1
  265. package/docs/source/lib/goog/debug/debug.js.src.html +0 -1
  266. package/docs/source/lib/goog/debug/entrypointregistry.js.src.html +0 -1
  267. package/docs/source/lib/goog/debug/error.js.src.html +0 -1
  268. package/docs/source/lib/goog/debug/logbuffer.js.src.html +0 -1
  269. package/docs/source/lib/goog/debug/logger.js.src.html +0 -1
  270. package/docs/source/lib/goog/debug/logrecord.js.src.html +0 -1
  271. package/docs/source/lib/goog/deps.js.src.html +0 -1
  272. package/docs/source/lib/goog/disposable/disposable.js.src.html +0 -1
  273. package/docs/source/lib/goog/disposable/idisposable.js.src.html +0 -1
  274. package/docs/source/lib/goog/dom/browserfeature.js.src.html +0 -1
  275. package/docs/source/lib/goog/dom/dom.js.src.html +0 -1
  276. package/docs/source/lib/goog/dom/nodetype.js.src.html +0 -1
  277. package/docs/source/lib/goog/dom/safe.js.src.html +0 -1
  278. package/docs/source/lib/goog/dom/tagname.js.src.html +0 -1
  279. package/docs/source/lib/goog/dom/tags.js.src.html +0 -1
  280. package/docs/source/lib/goog/dom/vendor.js.src.html +0 -1
  281. package/docs/source/lib/goog/events/browserevent.js.src.html +0 -1
  282. package/docs/source/lib/goog/events/browserfeature.js.src.html +0 -1
  283. package/docs/source/lib/goog/events/event.js.src.html +0 -1
  284. package/docs/source/lib/goog/events/eventid.js.src.html +0 -1
  285. package/docs/source/lib/goog/events/events.js.src.html +0 -1
  286. package/docs/source/lib/goog/events/eventtarget.js.src.html +0 -1
  287. package/docs/source/lib/goog/events/eventtype.js.src.html +0 -1
  288. package/docs/source/lib/goog/events/keycodes.js.src.html +0 -1
  289. package/docs/source/lib/goog/events/listenable.js.src.html +0 -1
  290. package/docs/source/lib/goog/events/listener.js.src.html +0 -1
  291. package/docs/source/lib/goog/events/listenermap.js.src.html +0 -1
  292. package/docs/source/lib/goog/fs/url.js.src.html +0 -1
  293. package/docs/source/lib/goog/functions/functions.js.src.html +0 -1
  294. package/docs/source/lib/goog/html/safehtml.js.src.html +0 -1
  295. package/docs/source/lib/goog/html/safescript.js.src.html +0 -1
  296. package/docs/source/lib/goog/html/safestyle.js.src.html +0 -1
  297. package/docs/source/lib/goog/html/safestylesheet.js.src.html +0 -1
  298. package/docs/source/lib/goog/html/safeurl.js.src.html +0 -1
  299. package/docs/source/lib/goog/html/trustedresourceurl.js.src.html +0 -1
  300. package/docs/source/lib/goog/html/uncheckedconversions.js.src.html +0 -1
  301. package/docs/source/lib/goog/i18n/bidi.js.src.html +0 -1
  302. package/docs/source/lib/goog/iter/iter.js.src.html +0 -1
  303. package/docs/source/lib/goog/json/json.js.src.html +0 -1
  304. package/docs/source/lib/goog/labs/testing/assertthat.js.src.html +0 -1
  305. package/docs/source/lib/goog/labs/testing/logicmatcher.js.src.html +0 -1
  306. package/docs/source/lib/goog/labs/testing/matcher.js.src.html +0 -1
  307. package/docs/source/lib/goog/labs/testing/numbermatcher.js.src.html +0 -1
  308. package/docs/source/lib/goog/labs/testing/objectmatcher.js.src.html +0 -1
  309. package/docs/source/lib/goog/labs/testing/stringmatcher.js.src.html +0 -1
  310. package/docs/source/lib/goog/labs/useragent/browser.js.src.html +0 -1
  311. package/docs/source/lib/goog/labs/useragent/engine.js.src.html +0 -1
  312. package/docs/source/lib/goog/labs/useragent/platform.js.src.html +0 -1
  313. package/docs/source/lib/goog/labs/useragent/util.js.src.html +0 -1
  314. package/docs/source/lib/goog/log/log.js.src.html +0 -1
  315. package/docs/source/lib/goog/math/box.js.src.html +0 -1
  316. package/docs/source/lib/goog/math/coordinate.js.src.html +0 -1
  317. package/docs/source/lib/goog/math/math.js.src.html +0 -1
  318. package/docs/source/lib/goog/math/rect.js.src.html +0 -1
  319. package/docs/source/lib/goog/math/size.js.src.html +0 -1
  320. package/docs/source/lib/goog/net/wrapperxmlhttpfactory.js.src.html +0 -1
  321. package/docs/source/lib/goog/net/xhrlike.js.src.html +0 -1
  322. package/docs/source/lib/goog/net/xmlhttp.js.src.html +0 -1
  323. package/docs/source/lib/goog/net/xmlhttpfactory.js.src.html +0 -1
  324. package/docs/source/lib/goog/object/object.js.src.html +0 -1
  325. package/docs/source/lib/goog/promise/promise.js.src.html +0 -1
  326. package/docs/source/lib/goog/promise/resolver.js.src.html +0 -1
  327. package/docs/source/lib/goog/promise/thenable.js.src.html +0 -1
  328. package/docs/source/lib/goog/reflect/reflect.js.src.html +0 -1
  329. package/docs/source/lib/goog/string/const.js.src.html +0 -1
  330. package/docs/source/lib/goog/string/string.js.src.html +0 -1
  331. package/docs/source/lib/goog/string/typedstring.js.src.html +0 -1
  332. package/docs/source/lib/goog/structs/collection.js.src.html +0 -1
  333. package/docs/source/lib/goog/structs/map.js.src.html +0 -1
  334. package/docs/source/lib/goog/structs/set.js.src.html +0 -1
  335. package/docs/source/lib/goog/structs/structs.js.src.html +0 -1
  336. package/docs/source/lib/goog/style/style.js.src.html +0 -1
  337. package/docs/source/lib/goog/testing/asserts.js.src.html +0 -1
  338. package/docs/source/lib/goog/testing/events/events.js.src.html +0 -1
  339. package/docs/source/lib/goog/testing/functionmock.js.src.html +0 -1
  340. package/docs/source/lib/goog/testing/jsunit.js.src.html +0 -1
  341. package/docs/source/lib/goog/testing/loosemock.js.src.html +0 -1
  342. package/docs/source/lib/goog/testing/mock.js.src.html +0 -1
  343. package/docs/source/lib/goog/testing/mockclock.js.src.html +0 -1
  344. package/docs/source/lib/goog/testing/mockcontrol.js.src.html +0 -1
  345. package/docs/source/lib/goog/testing/mockinterface.js.src.html +0 -1
  346. package/docs/source/lib/goog/testing/mockmatchers.js.src.html +0 -1
  347. package/docs/source/lib/goog/testing/objectpropertystring.js.src.html +0 -1
  348. package/docs/source/lib/goog/testing/propertyreplacer.js.src.html +0 -1
  349. package/docs/source/lib/goog/testing/recordfunction.js.src.html +0 -1
  350. package/docs/source/lib/goog/testing/stacktrace.js.src.html +0 -1
  351. package/docs/source/lib/goog/testing/strictmock.js.src.html +0 -1
  352. package/docs/source/lib/goog/testing/testcase.js.src.html +0 -1
  353. package/docs/source/lib/goog/testing/testrunner.js.src.html +0 -1
  354. package/docs/source/lib/goog/uri/uri.js.src.html +0 -1
  355. package/docs/source/lib/goog/uri/utils.js.src.html +0 -1
  356. package/docs/source/lib/goog/useragent/product.js.src.html +0 -1
  357. package/docs/source/lib/goog/useragent/product_isversion.js.src.html +0 -1
  358. package/docs/source/lib/goog/useragent/useragent.js.src.html +0 -1
  359. package/docs/source/lib/webdriver/actionsequence.js.src.html +0 -1
  360. package/docs/source/lib/webdriver/button.js.src.html +0 -1
  361. package/docs/source/lib/webdriver/capabilities.js.src.html +0 -1
  362. package/docs/source/lib/webdriver/command.js.src.html +0 -1
  363. package/docs/source/lib/webdriver/events.js.src.html +0 -1
  364. package/docs/source/lib/webdriver/http/http.js.src.html +0 -1
  365. package/docs/source/lib/webdriver/key.js.src.html +0 -1
  366. package/docs/source/lib/webdriver/locators.js.src.html +0 -1
  367. package/docs/source/lib/webdriver/logging.js.src.html +0 -1
  368. package/docs/source/lib/webdriver/promise.js.src.html +0 -1
  369. package/docs/source/lib/webdriver/serializable.js.src.html +0 -1
  370. package/docs/source/lib/webdriver/session.js.src.html +0 -1
  371. package/docs/source/lib/webdriver/stacktrace.js.src.html +0 -1
  372. package/docs/source/lib/webdriver/testing/asserts.js.src.html +0 -1
  373. package/docs/source/lib/webdriver/touchsequence.js.src.html +0 -1
  374. package/docs/source/lib/webdriver/until.js.src.html +0 -1
  375. package/docs/source/lib/webdriver/webdriver.js.src.html +0 -1
  376. package/docs/source/net/index.js.src.html +0 -1
  377. package/docs/source/net/portprober.js.src.html +0 -1
  378. package/docs/source/opera.js.src.html +0 -1
  379. package/docs/source/phantomjs.js.src.html +0 -1
  380. package/docs/source/proxy.js.src.html +0 -1
  381. package/docs/source/remote/index.js.src.html +0 -1
  382. package/docs/source/safari.js.src.html +0 -1
  383. package/docs/source/testing/assert.js.src.html +0 -1
  384. package/docs/source/testing/index.js.src.html +0 -1
  385. package/docs/types.js +0 -1
  386. package/lib/atoms/error.js +0 -202
  387. package/lib/atoms/json.js +0 -80
  388. package/lib/atoms/response.js +0 -110
  389. package/lib/atoms/userAgent.js +0 -257
  390. package/lib/goog/LICENSE +0 -176
  391. package/lib/goog/array/array.js +0 -1654
  392. package/lib/goog/asserts/asserts.js +0 -365
  393. package/lib/goog/async/freelist.js +0 -88
  394. package/lib/goog/async/nexttick.js +0 -241
  395. package/lib/goog/async/run.js +0 -133
  396. package/lib/goog/async/workqueue.js +0 -139
  397. package/lib/goog/base.js +0 -2548
  398. package/lib/goog/debug/debug.js +0 -653
  399. package/lib/goog/debug/entrypointregistry.js +0 -158
  400. package/lib/goog/debug/error.js +0 -63
  401. package/lib/goog/debug/logbuffer.js +0 -148
  402. package/lib/goog/debug/logger.js +0 -873
  403. package/lib/goog/debug/logrecord.js +0 -242
  404. package/lib/goog/deps.js +0 -151
  405. package/lib/goog/disposable/disposable.js +0 -307
  406. package/lib/goog/disposable/idisposable.js +0 -45
  407. package/lib/goog/dom/browserfeature.js +0 -72
  408. package/lib/goog/dom/dom.js +0 -2991
  409. package/lib/goog/dom/nodetype.js +0 -48
  410. package/lib/goog/dom/safe.js +0 -347
  411. package/lib/goog/dom/tagname.js +0 -160
  412. package/lib/goog/dom/tags.js +0 -41
  413. package/lib/goog/dom/vendor.js +0 -96
  414. package/lib/goog/events/browserevent.js +0 -400
  415. package/lib/goog/events/browserfeature.js +0 -85
  416. package/lib/goog/events/event.js +0 -143
  417. package/lib/goog/events/eventid.js +0 -47
  418. package/lib/goog/events/events.js +0 -984
  419. package/lib/goog/events/eventtarget.js +0 -394
  420. package/lib/goog/events/eventtype.js +0 -237
  421. package/lib/goog/events/keycodes.js +0 -427
  422. package/lib/goog/events/listenable.js +0 -335
  423. package/lib/goog/events/listener.js +0 -131
  424. package/lib/goog/events/listenermap.js +0 -308
  425. package/lib/goog/fs/url.js +0 -109
  426. package/lib/goog/functions/functions.js +0 -442
  427. package/lib/goog/html/safehtml.js +0 -757
  428. package/lib/goog/html/safescript.js +0 -234
  429. package/lib/goog/html/safestyle.js +0 -442
  430. package/lib/goog/html/safestylesheet.js +0 -276
  431. package/lib/goog/html/safeurl.js +0 -398
  432. package/lib/goog/html/trustedresourceurl.js +0 -224
  433. package/lib/goog/html/uncheckedconversions.js +0 -232
  434. package/lib/goog/i18n/bidi.js +0 -908
  435. package/lib/goog/iter/iter.js +0 -1302
  436. package/lib/goog/json/json.js +0 -363
  437. package/lib/goog/labs/testing/assertthat.js +0 -58
  438. package/lib/goog/labs/testing/logicmatcher.js +0 -212
  439. package/lib/goog/labs/testing/matcher.js +0 -80
  440. package/lib/goog/labs/testing/numbermatcher.js +0 -346
  441. package/lib/goog/labs/testing/objectmatcher.js +0 -317
  442. package/lib/goog/labs/testing/stringmatcher.js +0 -415
  443. package/lib/goog/labs/useragent/browser.js +0 -341
  444. package/lib/goog/labs/useragent/engine.js +0 -160
  445. package/lib/goog/labs/useragent/platform.js +0 -160
  446. package/lib/goog/labs/useragent/util.js +0 -148
  447. package/lib/goog/log/log.js +0 -197
  448. package/lib/goog/math/box.js +0 -398
  449. package/lib/goog/math/coordinate.js +0 -268
  450. package/lib/goog/math/math.js +0 -451
  451. package/lib/goog/math/rect.js +0 -476
  452. package/lib/goog/math/size.js +0 -227
  453. package/lib/goog/net/wrapperxmlhttpfactory.js +0 -71
  454. package/lib/goog/net/xhrlike.js +0 -124
  455. package/lib/goog/net/xmlhttp.js +0 -246
  456. package/lib/goog/net/xmlhttpfactory.js +0 -67
  457. package/lib/goog/object/object.js +0 -686
  458. package/lib/goog/promise/promise.js +0 -1350
  459. package/lib/goog/promise/resolver.js +0 -48
  460. package/lib/goog/promise/thenable.js +0 -126
  461. package/lib/goog/reflect/reflect.js +0 -77
  462. package/lib/goog/string/const.js +0 -182
  463. package/lib/goog/string/string.js +0 -1599
  464. package/lib/goog/string/typedstring.js +0 -48
  465. package/lib/goog/structs/collection.js +0 -56
  466. package/lib/goog/structs/map.js +0 -457
  467. package/lib/goog/structs/set.js +0 -279
  468. package/lib/goog/structs/structs.js +0 -354
  469. package/lib/goog/style/style.js +0 -2037
  470. package/lib/goog/testing/asserts.js +0 -1278
  471. package/lib/goog/testing/events/events.js +0 -767
  472. package/lib/goog/testing/functionmock.js +0 -175
  473. package/lib/goog/testing/jsunit.js +0 -162
  474. package/lib/goog/testing/loosemock.js +0 -242
  475. package/lib/goog/testing/mock.js +0 -645
  476. package/lib/goog/testing/mockclock.js +0 -606
  477. package/lib/goog/testing/mockcontrol.js +0 -220
  478. package/lib/goog/testing/mockinterface.js +0 -45
  479. package/lib/goog/testing/mockmatchers.js +0 -400
  480. package/lib/goog/testing/objectpropertystring.js +0 -68
  481. package/lib/goog/testing/propertyreplacer.js +0 -262
  482. package/lib/goog/testing/recordfunction.js +0 -215
  483. package/lib/goog/testing/stacktrace.js +0 -594
  484. package/lib/goog/testing/strictmock.js +0 -130
  485. package/lib/goog/testing/testcase.js +0 -1629
  486. package/lib/goog/testing/testrunner.js +0 -440
  487. package/lib/goog/uri/uri.js +0 -1524
  488. package/lib/goog/uri/utils.js +0 -1064
  489. package/lib/goog/useragent/product.js +0 -183
  490. package/lib/goog/useragent/product_isversion.js +0 -144
  491. package/lib/goog/useragent/useragent.js +0 -572
  492. package/lib/webdriver/actionsequence.js +0 -356
  493. package/lib/webdriver/builder.js +0 -207
  494. package/lib/webdriver/capabilities.js +0 -412
  495. package/lib/webdriver/events.js +0 -179
  496. package/lib/webdriver/firefoxdomexecutor.js +0 -175
  497. package/lib/webdriver/http/corsclient.js +0 -133
  498. package/lib/webdriver/http/http.js +0 -525
  499. package/lib/webdriver/http/xhrclient.js +0 -67
  500. package/lib/webdriver/locators.js +0 -257
  501. package/lib/webdriver/logging.js +0 -347
  502. package/lib/webdriver/session.js +0 -74
  503. package/lib/webdriver/stacktrace.js +0 -619
  504. package/lib/webdriver/test/builder_test.js +0 -53
  505. package/lib/webdriver/test/capabilities_test.js +0 -72
  506. package/lib/webdriver/test/events_test.js +0 -203
  507. package/lib/webdriver/test/http/corsclient_test.js +0 -151
  508. package/lib/webdriver/test/http/http_test.js +0 -428
  509. package/lib/webdriver/test/http/xhrclient_test.js +0 -196
  510. package/lib/webdriver/test/locators_test.js +0 -59
  511. package/lib/webdriver/test/logging_test.js +0 -85
  512. package/lib/webdriver/test/promise_error_test.js +0 -892
  513. package/lib/webdriver/test/promise_flow_test.js +0 -2365
  514. package/lib/webdriver/test/promise_generator_test.js +0 -323
  515. package/lib/webdriver/test/promise_test.js +0 -2012
  516. package/lib/webdriver/test/stacktrace_test.js +0 -480
  517. package/lib/webdriver/test/test_bootstrap.js +0 -67
  518. package/lib/webdriver/test/testing/asserts_test.js +0 -117
  519. package/lib/webdriver/test/testing/client_test.js +0 -88
  520. package/lib/webdriver/test/testing/testcase_test.js +0 -229
  521. package/lib/webdriver/test/testutil.js +0 -209
  522. package/lib/webdriver/test/testutil_test.js +0 -104
  523. package/lib/webdriver/test/until_test.js +0 -411
  524. package/lib/webdriver/test/webdriver_generator_test.js +0 -92
  525. package/lib/webdriver/test/webdriver_test.js +0 -2369
  526. package/lib/webdriver/testing/asserts.js +0 -487
  527. package/lib/webdriver/testing/client.js +0 -179
  528. package/lib/webdriver/testing/jsunit.js +0 -363
  529. package/lib/webdriver/testing/testcase.js +0 -168
  530. package/lib/webdriver/testing/window.js +0 -244
  531. package/lib/webdriver/touchsequence.js +0 -248
  532. package/lib/webdriver/until.js +0 -412
  533. package/lib/webdriver/webdriver.js +0 -2511
  534. package/test/_base_test.js +0 -129
package/docs/class_webdriver_logging_LogRecord.html DELETED
@@ -1,45 +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>LogRecord</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>Namespace:</b> <a href="namespace_webdriver_logging.html">webdriver.logging</a></div><div class="codelink"><a href="source/lib/webdriver/logging.js.src.html#l78">View Source</a></div><h1>class LogRecord</h1><p>LogRecord objects are used to pass logging requests between
2
- the logging framework and individual log Handlers.</p>
3
- <h3>new LogRecord(<wbr>level, msg, loggerName, opt_time, opt_sequenceNumber)</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>level<code><a href="class_webdriver_logging_Level.html">webdriver.logging.Level</a></code><dd><p>One of the level identifiers.</p>
4
- <dt>msg<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The string message.</p>
5
- <dt>loggerName<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The name of the source logger.</p>
6
- <dt>opt_time<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>=</code><dd><p>Time this log record was created if other than now.
7
- If 0, we use #goog.now.</p>
8
- <dt>opt_sequenceNumber<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>=</code><dd><p>Sequence number of this log record. This
9
- should only be passed in when restoring a log record from persistence.</p>
10
- </dl></div></div><h2>Instance Methods</h2><div id="getException" class="function"><div><h3>getException()<span class="codelink"><a href="source/lib/goog/debug/logrecord.js.src.html#l148">code »</a></span></h3><p>Get the exception that is part of the log record.</p>
11
- <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>the exception.</p>
12
- </dl></div></div></div></div><hr class="fn-sep"><div id="getLevel" class="function"><div><h3>getLevel()<span class="codelink"><a href="source/lib/goog/debug/logrecord.js.src.html#l177">code »</a></span></h3><p>Get the logging message level, for example Level.SEVERE.</p>
13
- <div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_logging_Level.html">webdriver.logging.Level</a></code><dd><p>the logging message level.</p>
14
- </dl></div></div></div></div><hr class="fn-sep"><div id="getLoggerName" class="function"><div><h3>getLoggerName()<span class="codelink"><a href="source/lib/goog/debug/logrecord.js.src.html#l138">code »</a></span></h3><p>Get the source Logger&#39;s name.</p>
15
- <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>source logger name (may be null).</p>
16
- </dl></div></div></div></div><hr class="fn-sep"><div id="getMessage" class="function"><div><h3>getMessage()<span class="codelink"><a href="source/lib/goog/debug/logrecord.js.src.html#l196">code »</a></span></h3><p>Get the &#34;raw&#34; log message, before localization or formatting.</p>
17
- <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>the raw message string.</p>
18
- </dl></div></div></div></div><hr class="fn-sep"><div id="getMillis" class="function"><div><h3>getMillis()<span class="codelink"><a href="source/lib/goog/debug/logrecord.js.src.html#l216">code »</a></span></h3><p>Get event time in milliseconds since 1970.</p>
19
- <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/Number">number</a></code><dd><p>event time in millis since 1970.</p>
20
- </dl></div></div></div></div><hr class="fn-sep"><div id="getSequenceNumber" class="function"><div><h3>getSequenceNumber()<span class="codelink"><a href="source/lib/goog/debug/logrecord.js.src.html#l239">code »</a></span></h3><p>Get the sequence number.</p>
21
- <p>
22
- Sequence numbers are normally assigned in the LogRecord
23
- constructor, which assigns unique sequence numbers to
24
- each new LogRecord in increasing order.
25
- </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/Number">number</a></code><dd><p>the sequence number.</p>
26
- </dl></div></div></div></div><hr class="fn-sep"><div id="reset" class="function"><div><h3>reset(<wbr>level, msg, loggerName, opt_time, opt_sequenceNumber)<span class="codelink"><a href="source/lib/goog/debug/logrecord.js.src.html#l118">code »</a></span></h3><p>Sets all fields of the log record.</p>
27
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>level<code><a href="class_webdriver_logging_Level.html">webdriver.logging.Level</a></code><dd><p>One of the level identifiers.</p>
28
- <dt>msg<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The string message.</p>
29
- <dt>loggerName<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The name of the source logger.</p>
30
- <dt>opt_time<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>=</code><dd><p>Time this log record was created if other than now.
31
- If 0, we use #goog.now.</p>
32
- <dt>opt_sequenceNumber<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>=</code><dd><p>Sequence number of this log record. This
33
- should only be passed in when restoring a log record from persistence.</p>
34
- </dl></div></div></div></div><hr class="fn-sep"><div id="setException" class="function"><div><h3>setException(<wbr>exception)<span class="codelink"><a href="source/lib/goog/debug/logrecord.js.src.html#l158">code »</a></span></h3><p>Set the exception that is part of the log record.</p>
35
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>exception<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code><dd><p>the exception.</p>
36
- </dl></div></div></div></div><hr class="fn-sep"><div id="setLevel" class="function"><div><h3>setLevel(<wbr>level)<span class="codelink"><a href="source/lib/goog/debug/logrecord.js.src.html#l186">code »</a></span></h3><p>Set the logging message level, for example Level.SEVERE.</p>
37
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>level<code><a href="class_webdriver_logging_Level.html">webdriver.logging.Level</a></code><dd><p>the logging message level.</p>
38
- </dl></div></div></div></div><hr class="fn-sep"><div id="setLoggerName" class="function"><div><h3>setLoggerName(<wbr>loggerName)<span class="codelink"><a href="source/lib/goog/debug/logrecord.js.src.html#l168">code »</a></span></h3><p>Get the source Logger&#39;s name.</p>
39
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>loggerName<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>source logger name (may be null).</p>
40
- </dl></div></div></div></div><hr class="fn-sep"><div id="setMessage" class="function"><div><h3>setMessage(<wbr>msg)<span class="codelink"><a href="source/lib/goog/debug/logrecord.js.src.html#l206">code »</a></span></h3><p>Set the &#34;raw&#34; log message, before localization or formatting.</p>
41
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>msg<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>the raw message string.</p>
42
- </dl></div></div></div></div><hr class="fn-sep"><div id="setMillis" class="function"><div><h3>setMillis(<wbr>time)<span class="codelink"><a href="source/lib/goog/debug/logrecord.js.src.html#l226">code »</a></span></h3><p>Set event time in milliseconds since 1970.</p>
43
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>time<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd><p>event time in millis since 1970.</p>
44
- </dl></div></div></div></div><h2>Compiler Constants</h2><div id="LogRecord.ENABLE_SEQUENCE_NUMBERS" class="property"><dl><dt><a href="source/lib/goog/debug/logrecord.js.src.html#l96">LogRecord.ENABLE_SEQUENCE_NUMBERS</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether to enable log sequence numbers.</p>
45
- </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>
package/docs/class_webdriver_logging_Logger.html DELETED
@@ -1,119 +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>Logger</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>Namespace:</b> <a href="namespace_webdriver_logging.html">webdriver.logging</a></div><div class="codelink"><a href="source/lib/webdriver/logging.js.src.html#l82">View Source</a></div><h1>class Logger</h1><p>The Logger is an object used for logging debug messages. Loggers are
2
- normally named, using a hierarchical dot-separated namespace. Logger names
3
- can be arbitrary strings, but they should normally be based on the package
4
- name or class name of the logged component, such as goog.net.BrowserChannel.</p>
5
- <p>The Logger object is loosely based on the java class
6
- java.util.logging.Logger. It supports different levels of filtering for
7
- different loggers.</p>
8
- <p>The logger object should never be instantiated by application code. It
9
- should always use the goog.debug.Logger.getLogger function.</p>
10
- <h3>new Logger(<wbr>name)</h3><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 name of the Logger.</p>
11
- </dl></div></div><h2>Instance Methods</h2><div id="addHandler" class="function"><div><h3>addHandler(<wbr>handler)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l400">code »</a></span></h3><p>Adds a handler to the logger. This doesn&#39;t use the event system because
12
- we want to be able to add logging to the event system.</p>
13
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>handler<code>Function</code><dd><p>Handler function to add.</p>
14
- </dl></div></div></div></div><hr class="fn-sep"><div id="config" class="function"><div><h3>config(<wbr>msg, opt_exception)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l639">code »</a></span></h3><p>Logs a message at the Logger.Level.CONFIG level.
15
- If the logger is currently enabled for the given message level then the
16
- given message is forwarded to all the registered output Handler objects.</p>
17
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>msg<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|function(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code><dd><p>The message to log.</p>
18
- <dt>opt_exception<code>?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>=</code><dd><p>An exception associated with the message.</p>
19
- </dl></div></div></div></div><hr class="fn-sep"><div id="fine" class="function"><div><h3>fine(<wbr>msg, opt_exception)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l653">code »</a></span></h3><p>Logs a message at the Logger.Level.FINE level.
20
- If the logger is currently enabled for the given message level then the
21
- given message is forwarded to all the registered output Handler objects.</p>
22
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>msg<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|function(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code><dd><p>The message to log.</p>
23
- <dt>opt_exception<code>?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>=</code><dd><p>An exception associated with the message.</p>
24
- </dl></div></div></div></div><hr class="fn-sep"><div id="finer" class="function"><div><h3>finer(<wbr>msg, opt_exception)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l667">code »</a></span></h3><p>Logs a message at the Logger.Level.FINER level.
25
- If the logger is currently enabled for the given message level then the
26
- given message is forwarded to all the registered output Handler objects.</p>
27
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>msg<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|function(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code><dd><p>The message to log.</p>
28
- <dt>opt_exception<code>?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>=</code><dd><p>An exception associated with the message.</p>
29
- </dl></div></div></div></div><hr class="fn-sep"><div id="finest" class="function"><div><h3>finest(<wbr>msg, opt_exception)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l681">code »</a></span></h3><p>Logs a message at the Logger.Level.FINEST level.
30
- If the logger is currently enabled for the given message level then the
31
- given message is forwarded to all the registered output Handler objects.</p>
32
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>msg<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|function(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code><dd><p>The message to log.</p>
33
- <dt>opt_exception<code>?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>=</code><dd><p>An exception associated with the message.</p>
34
- </dl></div></div></div></div><hr class="fn-sep"><div id="getChildren" class="function"><div><h3>getChildren()<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l448">code »</a></span></h3><p>Returns the children of this logger as a map of the child name to the logger.</p>
35
- <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>The map where the keys are the child leaf names and the
36
- values are the Logger objects.</p>
37
- </dl></div></div></div></div><hr class="fn-sep"><div id="getEffectiveLevel" class="function"><div><h3>getEffectiveLevel()<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l498">code »</a></span></h3><p>Returns the effective level of the logger based on its ancestors&#39; levels.</p>
38
- <div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_logging_Level.html">webdriver.logging.Level</a></code><dd><p>The level.</p>
39
- </dl></div></div></div></div><hr class="fn-sep"><div id="getLevel" class="function"><div><h3>getLevel()<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l488">code »</a></span></h3><p>Gets the log level specifying which message levels will be logged by this
40
- logger. Message levels lower than this value will be discarded.
41
- The level value Level.OFF can be used to turn off logging. If the level
42
- is null, it means that this node should inherit its level from its nearest
43
- ancestor with a specific (non-null) level value.</p>
44
- <div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_logging_Level.html">webdriver.logging.Level</a></code><dd><p>The level.</p>
45
- </dl></div></div></div></div><hr class="fn-sep"><div id="getLogRecord" class="function"><div><h3>getLogRecord(<wbr>level, msg, opt_exception)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l561">code »</a></span></h3><p>Creates a new log record and adds the exception (if present) to it.</p>
46
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>level<code><a href="class_webdriver_logging_Level.html">webdriver.logging.Level</a></code><dd><p>One of the level identifiers.</p>
47
- <dt>msg<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The string message.</p>
48
- <dt>opt_exception<code>?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>=</code><dd><p>An exception associated with the
49
- message.</p>
50
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_logging_LogRecord.html">webdriver.logging.LogRecord</a></code><dd><p>A log record.</p>
51
- </dl></div></div></div></div><hr class="fn-sep"><div id="getName" class="function"><div><h3>getName()<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l390">code »</a></span></h3><p>Gets the name of this logger.</p>
52
- <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>The name of this logger.</p>
53
- </dl></div></div></div></div><hr class="fn-sep"><div id="getParent" class="function"><div><h3>getParent()<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l438">code »</a></span></h3><p>Returns the parent of this logger.</p>
54
- <div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_logging_Logger.html">webdriver.logging.Logger</a></code><dd><p>The parent logger or null if this is the root.</p>
55
- </dl></div></div></div></div><hr class="fn-sep"><div id="info" class="function"><div><h3>info(<wbr>msg, opt_exception)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l625">code »</a></span></h3><p>Logs a message at the Logger.Level.INFO level.
56
- If the logger is currently enabled for the given message level then the
57
- given message is forwarded to all the registered output Handler objects.</p>
58
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>msg<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|function(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code><dd><p>The message to log.</p>
59
- <dt>opt_exception<code>?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>=</code><dd><p>An exception associated with the message.</p>
60
- </dl></div></div></div></div><hr class="fn-sep"><div id="isLoggable" class="function"><div><h3>isLoggable(<wbr>level)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l524">code »</a></span></h3><p>Checks if a message of the given level would actually be logged by this
61
- logger. This check is based on the Loggers effective level, which may be
62
- inherited from its parent.</p>
63
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>level<code><a href="class_webdriver_logging_Level.html">webdriver.logging.Level</a></code><dd><p>The level to check.</p>
64
- </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 message would be logged.</p>
65
- </dl></div></div></div></div><hr class="fn-sep"><div id="log" class="function"><div><h3>log(<wbr>level, msg, opt_exception)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l539">code »</a></span></h3><p>Logs a message. If the logger is currently enabled for the
66
- given message level then the given message is forwarded to all the
67
- registered output Handler objects.</p>
68
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>level<code><a href="class_webdriver_logging_Level.html">webdriver.logging.Level</a></code><dd><p>One of the level identifiers.</p>
69
- <dt>msg<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|function(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code><dd><p>The message to log.</p>
70
- <dt>opt_exception<code>?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>=</code><dd><p>An exception associated with the
71
- message.</p>
72
- </dl></div></div></div></div><hr class="fn-sep"><div id="logRecord" class="function"><div><h3>logRecord(<wbr>logRecord)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l694">code »</a></span></h3><p>Logs a LogRecord. If the logger is currently enabled for the
73
- given message level then the given message is forwarded to all the
74
- registered output Handler objects.</p>
75
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>logRecord<code><a href="class_webdriver_logging_LogRecord.html">webdriver.logging.LogRecord</a></code><dd><p>A log record to log.</p>
76
- </dl></div></div></div></div><hr class="fn-sep"><div id="removeHandler" class="function"><div><h3>removeHandler(<wbr>handler)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l423">code »</a></span></h3><p>Removes a handler from the logger. This doesn&#39;t use the event system because
77
- we want to be able to add logging to the event system.</p>
78
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>handler<code>Function</code><dd><p>Handler function to remove.</p>
79
- </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 handler was removed.</p>
80
- </dl></div></div></div></div><hr class="fn-sep"><div id="setLevel" class="function"><div><h3>setLevel(<wbr>level)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l465">code »</a></span></h3><p>Set the log level specifying which message levels will be logged by this
81
- logger. Message levels lower than this value will be discarded.
82
- The level value Level.OFF can be used to turn off logging. If the new level
83
- is null, it means that this node should inherit its level from its nearest
84
- ancestor with a specific (non-null) level value.</p>
85
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>level<code><a href="class_webdriver_logging_Level.html">webdriver.logging.Level</a></code><dd><p>The new level.</p>
86
- </dl></div></div></div></div><hr class="fn-sep"><div id="severe" class="function"><div><h3>severe(<wbr>msg, opt_exception)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l597">code »</a></span></h3><p>Logs a message at the Logger.Level.SEVERE level.
87
- If the logger is currently enabled for the given message level then the
88
- given message is forwarded to all the registered output Handler objects.</p>
89
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>msg<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|function(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code><dd><p>The message to log.</p>
90
- <dt>opt_exception<code>?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>=</code><dd><p>An exception associated with the message.</p>
91
- </dl></div></div></div></div><hr class="fn-sep"><div id="shout" class="function"><div><h3>shout(<wbr>msg, opt_exception)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l583">code »</a></span></h3><p>Logs a message at the Logger.Level.SHOUT level.
92
- If the logger is currently enabled for the given message level then the
93
- given message is forwarded to all the registered output Handler objects.</p>
94
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>msg<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|function(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code><dd><p>The message to log.</p>
95
- <dt>opt_exception<code>?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>=</code><dd><p>An exception associated with the message.</p>
96
- </dl></div></div></div></div><hr class="fn-sep"><div id="warning" class="function"><div><h3>warning(<wbr>msg, opt_exception)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l611">code »</a></span></h3><p>Logs a message at the Logger.Level.WARNING level.
97
- If the logger is currently enabled for the given message level then the
98
- given message is forwarded to all the registered output Handler objects.</p>
99
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>msg<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|function(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code><dd><p>The message to log.</p>
100
- <dt>opt_exception<code>?<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>=</code><dd><p>An exception associated with the message.</p>
101
- </dl></div></div></div></div><h2>Static Functions</h2><div id="Logger.getLogger" class="function"><div><h3>Logger.getLogger(<wbr>name)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l355">code »</a></span></h3><div class="tags"><span>deprecated</span></div><p>Finds or creates a logger for a named subsystem. If a logger has already been
102
- created with the given name it is returned. Otherwise a new logger is
103
- created. If a new logger is created its log level will be configured based
104
- on the LogManager configuration and it will configured to also send logging
105
- output to its parent&#39;s handlers. It will be registered in the LogManager
106
- global namespace.</p>
107
- <dl><dt>Deprecated<dd><p>use goog.log instead. http://go/goog-debug-logger-deprecated</p>
108
- </dl><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>A name for the logger. This should be a dot-separated
109
- name and should normally be based on the package name or class name of the
110
- subsystem, such as goog.net.BrowserChannel.</p>
111
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_logging_Logger.html">webdriver.logging.Logger</a></code><dd><p>The named logger.</p>
112
- </dl></div></div></div></div><hr class="fn-sep"><div id="Logger.logToProfilers" class="function"><div><h3>Logger.logToProfilers(<wbr>msg)<span class="codelink"><a href="source/lib/goog/debug/logger.js.src.html#l366">code »</a></span></h3><p>Logs a message to profiling tools, if available.
113
- https://developers.google.com/web-toolkit/speedtracer/logging-api
114
- http://msdn.microsoft.com/en-us/library/dd433074(VS.85).aspx</p>
115
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>msg<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The message to log.</p>
116
- </dl></div></div></div></div><h2>Static Properties</h2><div id="Logger.ROOT_LOGGER_NAME" class="property"><dl><dt><a href="source/lib/goog/debug/logger.js.src.html#l101">Logger.ROOT_LOGGER_NAME</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>No description.</dl></div><h2>Compiler Constants</h2><div id="Logger.ENABLE_HIERARCHY" class="property"><dl><dt><a href="source/lib/goog/debug/logger.js.src.html#l109">Logger.ENABLE_HIERARCHY</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Toggles whether loggers other than the root logger can have
117
- log handlers attached to them and whether they can have their log level
118
- set. Logging is a bit faster when this is set to false.</p>
119
- </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>
package/docs/class_webdriver_logging_Preferences.html DELETED
@@ -1,8 +0,0 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>Preferences</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>Namespace:</b> <a href="namespace_webdriver_logging.html">webdriver.logging</a></div><div class="codelink"><a href="source/lib/webdriver/logging.js.src.html#l284">View Source</a></div><h1>class Preferences</h1><p>Describes the log preferences for a WebDriver session.</p>
2
- <h3>new Preferences()</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dd>None.</dl></div></div><h2>Instance Methods</h2><div id="setLevel" class="function"><div><h3>setLevel(<wbr>type, level)<span class="codelink"><a href="source/lib/webdriver/logging.js.src.html#l265">code »</a></span></h3><p>Sets the desired logging level for a particular log type.</p>
3
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>type<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The log type.</p>
4
- <dt>level<code><a href="class_webdriver_logging_Level.html">webdriver.logging.Level</a></code><dd><p>The desired log level.</p>
5
- </dl></div></div></div></div><hr class="fn-sep"><div id="toJSON" class="function"><div><h3>toJSON(<wbr>arg0)<span class="codelink"><a href="source/lib/webdriver/logging.js.src.html#l274">code »</a></span></h3><p>Converts this instance to its JSON representation.</p>
6
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>arg0<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>=</code></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>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</code><dd><p>The JSON representation of this set of
7
- preferences.</p>
8
- </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>
package/docs/class_webdriver_promise_CancellationError.html DELETED
@@ -1,17 +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>CancellationError</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>Namespace:</b> <a href="namespace_webdriver_promise.html">webdriver.promise</a></div><div class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l708">View Source</a></div><h1>class CancellationError</h1><pre class="inheritance"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>
2
- &#x2514; goog.debug.Error
3
- &#x2514; webdriver.promise.CancellationError</pre><p>Error used when the computation of a promise is cancelled.</p>
4
- <h3>new CancellationError(<wbr>opt_msg)</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_msg<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>=</code><dd><p>The cancellation message.</p>
5
- </dl></div></div><h2>Instance Properties</h2><div id="description" class="property"><dl><dt>description<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>IE-only.</p>
6
- </dl></div><div id="fileName" class="property"><dl><dt>fileName<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>Mozilla-only</p>
7
- </dl></div><div id="lineNumber" class="property"><dl><dt>lineNumber<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd><p>Mozilla-only.</p>
8
- </dl></div><div id="message" class="property"><dl><dt><a href="source/lib/goog/debug/error.js.src.html#l47">message</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>No description.</dl></div><div id="name" class="property"><dl><dt><a href="source/lib/webdriver/promise.js.src.html#l716">name</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>No description.</dl></div><div id="reportErrorToServer" class="property"><dl><dt><a href="source/lib/goog/debug/error.js.src.html#l57">reportErrorToServer</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether to report this error to the server. Setting this to false will
9
- cause the error reporter to not report the error back to the server,
10
- which can be useful if the client knows that the error has already been
11
- logged on the server.</p>
12
- </dl></div><div id="sourceURL" class="property"><dl><dt>sourceURL<code>?</code><dd><p>Doesn&#39;t seem to exist, but closure/debug.js references it.</p>
13
- </dl></div><div id="stack" class="property"><dl><dt><a href="source/lib/goog/debug/error.js.src.html#l42">stack</a><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>No description.</dl></div><h2>Static Functions</h2><div id="CancellationError.wrap" class="function"><div><h3>CancellationError.wrap(<wbr>error, opt_msg)<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l730">code »</a></span></h3><p>Wraps the given error in a CancellationError.</p>
14
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>error<code>*</code><dd><p>The error to wrap.</p>
15
- <dt>opt_msg<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>=</code><dd><p>The prefix message to use.</p>
16
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_CancellationError.html">webdriver.promise.CancellationError</a></code><dd><p>A cancellation error.</p>
17
- </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>
package/docs/class_webdriver_promise_ControlFlow.html DELETED
@@ -1,153 +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>ControlFlow</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>Namespace:</b> <a href="namespace_webdriver_promise.html">webdriver.promise</a></div><div class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l1921">View Source</a></div><h1>class ControlFlow</h1><pre class="inheritance"><a href="class_webdriver_EventEmitter.html">webdriver.EventEmitter</a>
2
- &#x2514; webdriver.promise.ControlFlow</pre><p>Handles the execution of scheduled tasks, each of which may be an
3
- asynchronous operation. The control flow will ensure tasks are executed in
4
- the ordered scheduled, starting each task only once those before it have
5
- completed.</p>
6
- <p>Each task scheduled within this flow may return a
7
- <a href="class_webdriver_promise_Promise.html"><code>webdriver.promise.Promise</code></a> to indicate it is an asynchronous
8
- operation. The ControlFlow will wait for such promises to be resolved before
9
- marking the task as completed.</p>
10
- <p>Tasks and each callback registered on a <a href="class_webdriver_promise_Promise.html"><code>webdriver.promise.Promise</code></a>
11
- will be run in their own ControlFlow frame. Any tasks scheduled within a
12
- frame will take priority over previously scheduled tasks. Furthermore, if any
13
- of the tasks in the frame fail, the remainder of the tasks in that frame will
14
- be discarded and the failure will be propagated to the user through the
15
- callback/task&#39;s promised result.</p>
16
- <p>Each time a ControlFlow empties its task queue, it will fire an
17
- <a href="enum_webdriver_promise_ControlFlow_EventType.html#IDLE"><code>IDLE</code></a> event. Conversely,
18
- whenever the flow terminates due to an unhandled error, it will remove all
19
- remaining tasks in its queue and fire an
20
- <a href="enum_webdriver_promise_ControlFlow_EventType.html#UNCAUGHT_EXCEPTION"><code>UNCAUGHT_EXCEPTION</code></a> event. If there are no listeners registered with the
21
- flow, the error will be rethrown to the global error handler.</p>
22
- <p>Refer to the <a href="namespace_webdriver_promise.html"><code>webdriver.promise</code></a> module documentation for a detailed
23
- explanation of how the ControlFlow coordinates task execution.</p>
24
- <h3>new ControlFlow()</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dd>None.</dl></div></div><h2>Instance Methods</h2><div id="addListener" class="function"><div><h3>addListener(<wbr>type, listenerFn, opt_scope)<span class="codelink"><a href="source/lib/webdriver/events.js.src.html#l119">code »</a></span></h3><p>Registers a listener.</p>
25
- <p><b>Defined by: </b><a href="class_webdriver_EventEmitter.html#addListener">webdriver.EventEmitter</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>type<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The type of event to listen for.</p>
26
- <dt>listenerFn<code>Function</code><dd><p>The function to invoke when the event is fired.</p>
27
- <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 invoke the listener.</p>
28
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_EventEmitter.html">webdriver.EventEmitter</a></code><dd><p>A self reference.</p>
29
- </dl></div></div></div></div><hr class="fn-sep"><div id="async" class="function"><div><h3>async(<wbr>fn, opt_self, var_args)<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l2288">code »</a></span></h3><p>Executes a function in the next available turn of the JavaScript event
30
- loop. This ensures the function runs with its own task queue and any
31
- scheduled tasks will run in &#34;parallel&#34; to those scheduled in the current
32
- function.</p>
33
- <pre><code>flow.execute(() &#61;&gt; console.log(&#39;a&#39;));
34
- flow.execute(() &#61;&gt; console.log(&#39;b&#39;));
35
- flow.execute(() &#61;&gt; console.log(&#39;c&#39;));
36
- flow.async(() &#61;&gt; {
37
- flow.execute(() &#61;&gt; console.log(&#39;d&#39;));
38
- flow.execute(() &#61;&gt; console.log(&#39;e&#39;));
39
- });
40
- flow.async(() &#61;&gt; {
41
- flow.execute(() &#61;&gt; console.log(&#39;f&#39;));
42
- flow.execute(() &#61;&gt; console.log(&#39;g&#39;));
43
- });
44
- flow.once(&#39;idle&#39;, () &#61;&gt; console.log(&#39;fin&#39;));
45
- // a
46
- // d
47
- // f
48
- // b
49
- // e
50
- // g
51
- // c
52
- // fin
53
- </code></pre>
54
- <p>If the function itself throws, the error will be treated the same as an
55
- unhandled rejection within the control flow.</p>
56
- <p><strong>NOTE</strong>: This function is considered <em>unstable</em>.</p>
57
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>fn<code>Function</code><dd><p>The function to execute.</p>
58
- <dt>opt_self<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 context to run the function.</p>
59
- <dt>var_args<code>...*</code><dd><p>Any arguments to pass to the function.</p>
60
- </dl></div></div></div></div><hr class="fn-sep"><div id="emit" class="function"><div><h3>emit(<wbr>type, var_args)<span class="codelink"><a href="source/lib/webdriver/events.js.src.html#l47">code »</a></span></h3><p>Fires an event and calls all listeners.</p>
61
- <p><b>Defined by: </b><a href="class_webdriver_EventEmitter.html#emit">webdriver.EventEmitter</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>type<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The type of event to emit.</p>
62
- <dt>var_args<code>...*</code><dd><p>Any arguments to pass to each listener.</p>
63
- </dl></div></div></div></div><hr class="fn-sep"><div id="execute" class="function"><div><h3><code>&lt;T&gt;</code> execute(<wbr>fn, opt_description)<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l2111">code »</a></span></h3><p>Schedules a task for execution. If there is nothing currently in the
64
- queue, the task will be executed in the next turn of the event loop. If
65
- the task function is a generator, the task will be executed using
66
- <a href="namespace_webdriver_promise.html#consume"><code>webdriver.promise.consume</code></a>.</p>
67
- <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
68
- call to start the task. If the function returns a
69
- <a href="class_webdriver_promise_Promise.html"><code>webdriver.promise.Promise</code></a>, this instance will wait for it to be
70
- resolved before starting the next task.</p>
71
- <dt>opt_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 task.</p>
72
- </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
73
- with the result of the action.</p>
74
- </dl></div></div></div></div><hr class="fn-sep"><div id="getSchedule" class="function"><div><h3>getSchedule(<wbr>opt_includeStackTraces)<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l2023">code »</a></span></h3><p>Generates an annotated string describing the internal state of this control
75
- flow, including the currently executing as well as pending tasks. If
76
- <code>opt_includeStackTraces &#61;&#61;&#61; true</code>, the string will include the
77
- stack trace from when each task was scheduled.</p>
78
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_includeStackTraces<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>=</code><dd><p>Whether to include the stack traces
79
- from when each task was scheduled. Defaults to false.</p>
80
- </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>String representation of this flow&#39;s internal state.</p>
81
- </dl></div></div></div></div><hr class="fn-sep"><div id="isIdle" class="function"><div><h3>isIdle()<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l2000">code »</a></span></h3><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 this flow is currently idle.</p>
82
- </dl></div></div></div></div><hr class="fn-sep"><div id="listeners" class="function"><div><h3>listeners(<wbr>type)<span class="codelink"><a href="source/lib/webdriver/events.js.src.html#l74">code »</a></span></h3><p>Returns a mutable list of listeners for a specific type of event.</p>
83
- <p><b>Defined by: </b><a href="class_webdriver_EventEmitter.html#listeners">webdriver.EventEmitter</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>type<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The type of event to retrieve the listeners for.</p>
84
- </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/Array">Array</a>&lt;{fn: Function, oneshot: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>, scope: ?(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)}&gt;</code><dd><p>The registered listeners for
85
- the given event type.</p>
86
- </dl></div></div></div></div><hr class="fn-sep"><div id="on" class="function"><div><h3>on(<wbr>type, listenerFn, opt_scope)<span class="codelink"><a href="source/lib/webdriver/events.js.src.html#l145">code »</a></span></h3><p>An alias for <code>#addListener()</code>.</p>
87
- <p><b>Defined by: </b><a href="class_webdriver_EventEmitter.html#on">webdriver.EventEmitter</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>type<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The type of event to listen for.</p>
88
- <dt>listenerFn<code>Function</code><dd><p>The function to invoke when the event is fired.</p>
89
- <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 invoke the listener.</p>
90
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_EventEmitter.html">webdriver.EventEmitter</a></code><dd><p>A self reference.</p>
91
- </dl></div></div></div></div><hr class="fn-sep"><div id="once" class="function"><div><h3>once(<wbr>type, listenerFn, opt_scope)<span class="codelink"><a href="source/lib/webdriver/events.js.src.html#l133">code »</a></span></h3><p>Registers a one-time listener which will be called only the first time an
92
- event is emitted, after which it will be removed.</p>
93
- <p><b>Defined by: </b><a href="class_webdriver_EventEmitter.html#once">webdriver.EventEmitter</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>type<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The type of event to listen for.</p>
94
- <dt>listenerFn<code>Function</code><dd><p>The function to invoke when the event is fired.</p>
95
- <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 invoke the listener.</p>
96
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_EventEmitter.html">webdriver.EventEmitter</a></code><dd><p>A self reference.</p>
97
- </dl></div></div></div></div><hr class="fn-sep"><div id="removeAllListeners" class="function"><div><h3>removeAllListeners(<wbr>opt_type)<span class="codelink"><a href="source/lib/webdriver/events.js.src.html#l176">code »</a></span></h3><p>Removes all listeners for a specific type of event. If no event is
98
- specified, all listeners across all types will be removed.</p>
99
- <p><b>Defined by: </b><a href="class_webdriver_EventEmitter.html#removeAllListeners">webdriver.EventEmitter</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_type<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>=</code><dd><p>The type of event to remove listeners from.</p>
100
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_EventEmitter.html">webdriver.EventEmitter</a></code><dd><p>A self reference.</p>
101
- </dl></div></div></div></div><hr class="fn-sep"><div id="removeListener" class="function"><div><h3>removeListener(<wbr>type, listenerFn)<span class="codelink"><a href="source/lib/webdriver/events.js.src.html#l155">code »</a></span></h3><p>Removes a previously registered event listener.</p>
102
- <p><b>Defined by: </b><a href="class_webdriver_EventEmitter.html#removeListener">webdriver.EventEmitter</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>type<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd><p>The type of event to unregister.</p>
103
- <dt>listenerFn<code>Function</code><dd><p>The handler function to remove.</p>
104
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_EventEmitter.html">webdriver.EventEmitter</a></code><dd><p>A self reference.</p>
105
- </dl></div></div></div></div><hr class="fn-sep"><div id="reset" class="function"><div><h3>reset()<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l2007">code »</a></span></h3><p>Resets this instance, clearing its queue and removing all event listeners.</p>
106
- </div></div><hr class="fn-sep"><div id="setPropagateUnhandledRejections" class="function"><div><h3>setPropagateUnhandledRejections(<wbr>propagate)<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l1993">code »</a></span></h3><p>Sets whether any unhandled rejections should propagate up through the
107
- control flow stack and cause rejections within parent tasks. If error
108
- propagation is disabled, tasks will not be aborted when an unhandled
109
- promise rejection is detected, but the rejection <em>will</em> trigger an
110
- <a href="enum_webdriver_promise_ControlFlow_EventType.html#UNCAUGHT_EXCEPTION"><code>webdriver.promise.ControlFlow.EventType.UNCAUGHT_EXCEPTION</code></a>
111
- event.</p>
112
- <p>The default behavior is to propagate all unhandled rejections. <em>The use
113
- of this option is highly discouraged.</em></p>
114
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>propagate<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>whether to propagate errors.</p>
115
- </dl></div></div></div></div><hr class="fn-sep"><div id="timeout" class="function"><div><h3>timeout(<wbr>ms, opt_description)<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l2140">code »</a></span></h3><p>Inserts a <code>setTimeout</code> into the command queue. This is equivalent to
116
- a thread sleep in a synchronous programming language.</p>
117
- <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 timeout delay, in milliseconds.</p>
118
- <dt>opt_description<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>=</code><dd><p>A description to accompany the timeout.</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></code><dd><p>A promise that will be resolved with
120
- the result of the action.</p>
121
- </dl></div></div></div></div><hr class="fn-sep"><div id="toString" class="function"><div><h3>toString()<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l1976">code »</a></span></h3><p>Returns a string representation of this control flow, which is its current
122
- <a href="class_webdriver_promise_ControlFlow.html#getSchedule"><code>schedule</code></a>, sans task stack traces.</p>
123
- <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>The string representation of this contorl flow.</p>
124
- </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/promise.js.src.html#l2183">code »</a></span></h3><p>Schedules a task that shall wait for a condition to hold. Each condition
125
- function may return any value, but it will always be evaluated as a
126
- boolean.</p>
127
- <p>Condition functions may schedule sub-tasks with this instance, however,
128
- their execution time will be factored into whether a wait has timed out.</p>
129
- <p>In the event a condition returns a Promise, the polling loop will wait for
130
- it to be resolved before evaluating whether the condition has been
131
- satisfied. The resolution time for a promise is factored into whether a
132
- wait has timed out.</p>
133
- <p>If the condition function throws, or returns a rejected promise, the
134
- wait task will fail.</p>
135
- <p>If the condition is defined as a promise, the flow will wait for it to
136
- settle. If the timeout expires before the promise settles, the promise
137
- returned by this function will be rejected.</p>
138
- <p>If this function is invoked with <code>timeout &#61;&#61;&#61; 0</code>, or the timeout is
139
- omitted, the flow will wait indefinitely for the condition to be satisfied.</p>
140
- <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;|function(): ?)</code><dd><p>The condition to poll,
141
- or a promise to wait on.</p>
142
- <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, in milliseconds, for the
143
- condition to hold before timing out. If omitted, the flow will wait
144
- indefinitely.</p>
145
- <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 error message to include if the
146
- wait times out; defaults to the empty string.</p>
147
- </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
148
- when the condition has been satisified. The promise shall be rejected
149
- if the wait times out waiting for the condition.</p>
150
- </dl></div><div class="fn-details"><div><b>Throws</b></div><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError">TypeError</a></code><dd><p>If condition is not a function or promise or if timeout
151
- is not a number &gt;&#61; 0.</p>
152
- </dl></div></div></div></div><h2>Types</h2><dl><dt><a href="enum_webdriver_promise_ControlFlow_EventType.html">ControlFlow.EventType</a><dd><p>Events that may be emitted by an <a href="class_webdriver_promise_ControlFlow.html"><code>webdriver.promise.ControlFlow</code></a>.</p>
153
- </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>
package/docs/class_webdriver_promise_Deferred.html DELETED
@@ -1,84 +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>Deferred</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>Namespace:</b> <a href="namespace_webdriver_promise.html">webdriver.promise</a></div><div class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l1362">View Source</a></div><h1>class Deferred&lt;T&gt;</h1><dl><dt>All implemented interfaces<dd><code>IThenable&lt;T&gt;</code><dd><code><a href="interface_webdriver_promise_Thenable.html">webdriver.promise.Thenable</a>&lt;T&gt;</code></dl><p>Represents a value that will be resolved at some point in the future. This
2
- class represents the protected &#34;producer&#34; half of a Promise - each Deferred
3
- has a <code>promise</code> property that may be returned to consumers for
4
- registering callbacks, reserving the ability to resolve the deferred to the
5
- producer.</p>
6
- <p>If this Deferred is rejected and there are no listeners registered before
7
- the next turn of the event loop, the rejection will be passed to the
8
- <a href="class_webdriver_promise_ControlFlow.html"><code>webdriver.promise.ControlFlow</code></a> as an unhandled failure.</p>
9
- <h3>new Deferred(<wbr>opt_flow)</h3><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_flow<code>?<a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a>=</code><dd><p>The control flow this instance was
10
- created under. This should only be provided during unit tests.</p>
11
- </dl></div></div><h2>Instance Methods</h2><div id="cancel" class="function"><div><h3>cancel(<wbr>opt_reason)<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l1410">code »</a></span></h3><p>Cancels the computation of this promise&#39;s value, rejecting the promise in
12
- the process. This method is a no-op if the promise has already been
13
- resolved.</p>
14
- <p><b>Specified by: </b><a href="interface_webdriver_promise_Thenable.html#cancel">webdriver.promise.Thenable</a></p><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_reason<code>?(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>|<a href="class_webdriver_promise_CancellationError.html">webdriver.promise.CancellationError</a>)=</code><dd><p>The reason this
15
- promise is being cancelled.</p>
16
- </dl></div></div></div></div><hr class="fn-sep"><div id="fulfill" class="function"><div><h3>fulfill(<wbr>opt_value)<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l1388">code »</a></span></h3><p>Resolves this deferred with the given value. It is safe to call this as a
17
- normal function (with no bound &#34;this&#34;).</p>
18
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_value<code>?(T|{then: ?})=</code><dd><p>The fulfilled value.</p>
19
- </dl></div></div></div></div><hr class="fn-sep"><div id="isPending" class="function"><div><h3>isPending()<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l1405">code »</a></span></h3><p><b>Specified by: </b><a href="interface_webdriver_promise_Thenable.html#isPending">webdriver.promise.Thenable</a></p><div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code><dd><p>Whether this promise&#39;s value is still being computed.</p>
20
- </dl></div></div></div></div><hr class="fn-sep"><div id="reject" class="function"><div><h3>reject(<wbr>opt_reason)<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l1398">code »</a></span></h3><p>Rejects this promise with the given reason. It is safe to call this as a
21
- normal function (with no bound &#34;this&#34;).</p>
22
- <div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_reason<code>*=</code><dd><p>The rejection reason.</p>
23
- </dl></div></div></div></div><hr class="fn-sep"><div id="then" class="function"><div><h3>then(<wbr>opt_callback, opt_errback)<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l1418">code »</a></span></h3><div class="tags"><span>deprecated</span></div><p>Registers listeners for when this instance is resolved.</p>
24
- <p><b>Specified by: </b><a href="interface_webdriver_promise_Thenable.html#then">webdriver.promise.Thenable</a>, <a href="#then">IThenable</a></p><dl><dt>Deprecated<dd><p>Use <code>then</code> from the promise property directly.</p>
25
- </dl><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>opt_callback<code>?function(T): (R|IThenable&lt;R&gt;)=</code><dd><p>The
26
- function to call if this promise is successfully resolved. The function
27
- should expect a single argument: the promise&#39;s resolved value.</p>
28
- <dt>opt_errback<code>?function(*): (R|IThenable&lt;R&gt;)=</code><dd><p>The function to call if this promise is rejected. The function should
29
- expect a single argument: the rejection reason.</p>
30
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code><dd><p>A new promise which will be
31
- resolved with the result of the invoked callback.</p>
32
- </dl></div></div></div></div><hr class="fn-sep"><div id="thenCatch" class="function"><div><h3>thenCatch(<wbr>errback)<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l1426">code »</a></span></h3><div class="tags"><span>deprecated</span></div><p>Registers a listener for when this promise is rejected. This is synonymous
33
- with the <code>catch</code> clause in a synchronous API:</p>
34
- <pre><code>// Synchronous API:
35
- try {
36
- doSynchronousWork();
37
- } catch (ex) {
38
- console.error(ex);
39
- }
40
-
41
- // Asynchronous promise API:
42
- doAsynchronousWork().thenCatch(function(ex) {
43
- console.error(ex);
44
- });
45
- </code></pre>
46
- <p><b>Specified by: </b><a href="interface_webdriver_promise_Thenable.html#thenCatch">webdriver.promise.Thenable</a></p><dl><dt>Deprecated<dd><p>Use <code>thenCatch</code> from the promise property directly.</p>
47
- </dl><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>errback<code>function(*): (R|IThenable&lt;R&gt;)</code><dd><p>The
48
- function to call if this promise is rejected. The function should
49
- expect a single argument: the rejection reason.</p>
50
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code><dd><p>A new promise which will be
51
- resolved with the result of the invoked callback.</p>
52
- </dl></div></div></div></div><hr class="fn-sep"><div id="thenFinally" class="function"><div><h3>thenFinally(<wbr>callback)<span class="codelink"><a href="source/lib/webdriver/promise.js.src.html#l1434">code »</a></span></h3><div class="tags"><span>deprecated</span></div><p>Registers a listener to invoke when this promise is resolved, regardless
53
- of whether the promise&#39;s value was successfully computed. This function
54
- is synonymous with the <code>finally</code> clause in a synchronous API:</p>
55
- <pre><code>// Synchronous API:
56
- try {
57
- doSynchronousWork();
58
- } finally {
59
- cleanUp();
60
- }
61
-
62
- // Asynchronous promise API:
63
- doAsynchronousWork().thenFinally(cleanUp);
64
- </code></pre>
65
- <p><strong>Note:</strong> similar to the <code>finally</code> clause, if the registered
66
- callback returns a rejected promise or throws an error, it will silently
67
- replace the rejection error (if any) from this promise:</p>
68
- <pre><code>try {
69
- throw Error(&#39;one&#39;);
70
- } finally {
71
- throw Error(&#39;two&#39;); // Hides Error: one
72
- }
73
-
74
- promise.rejected(Error(&#39;one&#39;))
75
- .thenFinally(function() {
76
- throw Error(&#39;two&#39;); // Hides Error: one
77
- });
78
- </code></pre>
79
- <p><b>Specified by: </b><a href="interface_webdriver_promise_Thenable.html#thenFinally">webdriver.promise.Thenable</a></p><dl><dt>Deprecated<dd><p>Use <code>thenFinally</code> from the promise property directly.</p>
80
- </dl><div><div class="fn-details"><div><b>Parameters</b></div><dl><dt>callback<code>function(): (R|IThenable&lt;R&gt;)</code><dd><p>The function
81
- to call when this promise is resolved.</p>
82
- </dl></div><div class="fn-details"><div><b>Returns</b></div><dl><dt><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code><dd><p>A promise that will be fulfilled
83
- with the callback result.</p>
84
- </dl></div></div></div></div><h2>Instance Properties</h2><div id="promise" class="property"><dl><dt><a href="source/lib/webdriver/promise.js.src.html#l1371">promise</a><code><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>&lt;T&gt;</code><dd>No description.</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>