selenium-webdriver 2.43.5 → 2.44.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (219) hide show
  1. package/CHANGES.md +20 -0
  2. package/README.md +8 -13
  3. package/builder.js +4 -3
  4. package/docs/class_webdriver_Alert.html +6 -6
  5. package/docs/class_webdriver_AlertPromise.html +6 -6
  6. package/docs/class_webdriver_UnhandledAlertError.html +4 -4
  7. package/docs/class_webdriver_WebDriver.html +39 -37
  8. package/docs/class_webdriver_WebDriver_Logs.html +3 -3
  9. package/docs/class_webdriver_WebDriver_Navigation.html +5 -5
  10. package/docs/class_webdriver_WebDriver_Options.html +9 -9
  11. package/docs/class_webdriver_WebDriver_TargetLocator.html +6 -6
  12. package/docs/class_webdriver_WebDriver_Timeouts.html +4 -4
  13. package/docs/class_webdriver_WebDriver_Window.html +6 -6
  14. package/docs/class_webdriver_WebElement.html +23 -23
  15. package/docs/class_webdriver_WebElementPromise.html +22 -22
  16. package/docs/class_webdriver_promise_CancellationError.html +3 -0
  17. package/docs/class_webdriver_promise_ControlFlow.html +32 -32
  18. package/docs/class_webdriver_promise_Deferred.html +7 -8
  19. package/docs/class_webdriver_promise_Frame_.html +14 -30
  20. package/docs/class_webdriver_promise_Promise.html +2 -2
  21. package/docs/class_webdriver_promise_Task_.html +12 -12
  22. package/docs/class_webdriver_until_Condition.html +3 -0
  23. package/docs/enum_webdriver_Key.html +1 -1
  24. package/docs/enum_webdriver_promise_ControlFlow_EventType.html +1 -1
  25. package/docs/enum_webdriver_promise_Deferred_State_.html +1 -1
  26. package/docs/index.html +8 -13
  27. package/docs/interface_webdriver_promise_Thenable.html +8 -10
  28. package/docs/license.html +1 -1
  29. package/docs/module_selenium-webdriver.html +2 -2
  30. package/docs/module_selenium-webdriver__base.html +1 -1
  31. package/docs/module_selenium-webdriver__base_class_Context.html +1 -1
  32. package/docs/module_selenium-webdriver_builder.html +1 -1
  33. package/docs/module_selenium-webdriver_builder_class_Builder.html +1 -1
  34. package/docs/module_selenium-webdriver_chrome.html +1 -1
  35. package/docs/module_selenium-webdriver_chrome_class_Driver.html +2 -2
  36. package/docs/module_selenium-webdriver_chrome_class_Options.html +2 -2
  37. package/docs/module_selenium-webdriver_chrome_class_ServiceBuilder.html +1 -1
  38. package/docs/module_selenium-webdriver_error.html +1 -1
  39. package/docs/module_selenium-webdriver_executors.html +1 -1
  40. package/docs/module_selenium-webdriver_firefox.html +1 -1
  41. package/docs/module_selenium-webdriver_firefox_binary.html +1 -1
  42. package/docs/module_selenium-webdriver_firefox_binary_class_Binary.html +1 -1
  43. package/docs/module_selenium-webdriver_firefox_class_Driver.html +2 -2
  44. package/docs/module_selenium-webdriver_firefox_class_Options.html +1 -1
  45. package/docs/module_selenium-webdriver_firefox_extension.html +1 -1
  46. package/docs/module_selenium-webdriver_firefox_profile.html +1 -1
  47. package/docs/module_selenium-webdriver_firefox_profile_class_Profile.html +1 -1
  48. package/docs/module_selenium-webdriver_http.html +1 -1
  49. package/docs/module_selenium-webdriver_http_class_HttpClient.html +1 -1
  50. package/docs/module_selenium-webdriver_http_util.html +1 -1
  51. package/docs/module_selenium-webdriver_io.html +1 -1
  52. package/docs/module_selenium-webdriver_io_exec.html +1 -1
  53. package/docs/module_selenium-webdriver_net.html +1 -1
  54. package/docs/module_selenium-webdriver_net_portprober.html +1 -1
  55. package/docs/module_selenium-webdriver_phantomjs.html +1 -1
  56. package/docs/module_selenium-webdriver_phantomjs_class_Driver.html +2 -2
  57. package/docs/module_selenium-webdriver_proxy.html +1 -1
  58. package/docs/module_selenium-webdriver_remote.html +1 -1
  59. package/docs/module_selenium-webdriver_remote_class_DriverService.html +2 -2
  60. package/docs/module_selenium-webdriver_remote_class_SeleniumServer.html +2 -2
  61. package/docs/module_selenium-webdriver_testing.html +16 -29
  62. package/docs/module_selenium-webdriver_testing_assert.html +1 -1
  63. package/docs/namespace_webdriver_promise.html +18 -20
  64. package/docs/namespace_webdriver_stacktrace.html +15 -15
  65. package/docs/namespace_webdriver_until.html +32 -0
  66. package/docs/source/_base.js.src.html +1 -1
  67. package/docs/source/builder.js.src.html +1 -1
  68. package/docs/source/chrome.js.src.html +1 -1
  69. package/docs/source/error.js.src.html +1 -1
  70. package/docs/source/executors.js.src.html +1 -1
  71. package/docs/source/firefox/binary.js.src.html +1 -1
  72. package/docs/source/firefox/extension.js.src.html +1 -1
  73. package/docs/source/firefox/index.js.src.html +1 -1
  74. package/docs/source/firefox/profile.js.src.html +1 -1
  75. package/docs/source/http/index.js.src.html +1 -1
  76. package/docs/source/http/util.js.src.html +1 -1
  77. package/docs/source/index.js.src.html +1 -1
  78. package/docs/source/io/exec.js.src.html +1 -1
  79. package/docs/source/io/index.js.src.html +1 -1
  80. package/docs/source/lib/atoms/error.js.src.html +1 -1
  81. package/docs/source/lib/atoms/json.js.src.html +1 -1
  82. package/docs/source/lib/atoms/response.js.src.html +1 -1
  83. package/docs/source/lib/atoms/userAgent.js.src.html +1 -1
  84. package/docs/source/lib/goog/array/array.js.src.html +1 -1
  85. package/docs/source/lib/goog/asserts/asserts.js.src.html +1 -1
  86. package/docs/source/lib/goog/async/nexttick.js.src.html +1 -1
  87. package/docs/source/lib/goog/async/run.js.src.html +1 -1
  88. package/docs/source/lib/goog/base.js.src.html +1 -1
  89. package/docs/source/lib/goog/debug/debug.js.src.html +1 -1
  90. package/docs/source/lib/goog/debug/entrypointregistry.js.src.html +1 -1
  91. package/docs/source/lib/goog/debug/error.js.src.html +1 -1
  92. package/docs/source/lib/goog/debug/logbuffer.js.src.html +1 -1
  93. package/docs/source/lib/goog/debug/logger.js.src.html +1 -1
  94. package/docs/source/lib/goog/debug/logrecord.js.src.html +1 -1
  95. package/docs/source/lib/goog/deps.js.src.html +1 -1
  96. package/docs/source/lib/goog/disposable/disposable.js.src.html +1 -1
  97. package/docs/source/lib/goog/disposable/idisposable.js.src.html +1 -1
  98. package/docs/source/lib/goog/dom/browserfeature.js.src.html +1 -1
  99. package/docs/source/lib/goog/dom/dom.js.src.html +1 -1
  100. package/docs/source/lib/goog/dom/nodetype.js.src.html +1 -1
  101. package/docs/source/lib/goog/dom/tagname.js.src.html +1 -1
  102. package/docs/source/lib/goog/dom/vendor.js.src.html +1 -1
  103. package/docs/source/lib/goog/events/browserevent.js.src.html +1 -1
  104. package/docs/source/lib/goog/events/browserfeature.js.src.html +1 -1
  105. package/docs/source/lib/goog/events/event.js.src.html +1 -1
  106. package/docs/source/lib/goog/events/eventid.js.src.html +1 -1
  107. package/docs/source/lib/goog/events/events.js.src.html +1 -1
  108. package/docs/source/lib/goog/events/eventtarget.js.src.html +1 -1
  109. package/docs/source/lib/goog/events/eventtype.js.src.html +1 -1
  110. package/docs/source/lib/goog/events/keycodes.js.src.html +1 -1
  111. package/docs/source/lib/goog/events/listenable.js.src.html +1 -1
  112. package/docs/source/lib/goog/events/listener.js.src.html +1 -1
  113. package/docs/source/lib/goog/events/listenermap.js.src.html +1 -1
  114. package/docs/source/lib/goog/functions/functions.js.src.html +1 -1
  115. package/docs/source/lib/goog/iter/iter.js.src.html +1 -1
  116. package/docs/source/lib/goog/json/json.js.src.html +1 -1
  117. package/docs/source/lib/goog/labs/testing/assertthat.js.src.html +1 -1
  118. package/docs/source/lib/goog/labs/testing/logicmatcher.js.src.html +1 -1
  119. package/docs/source/lib/goog/labs/testing/matcher.js.src.html +1 -1
  120. package/docs/source/lib/goog/labs/testing/numbermatcher.js.src.html +1 -1
  121. package/docs/source/lib/goog/labs/testing/objectmatcher.js.src.html +1 -1
  122. package/docs/source/lib/goog/labs/testing/stringmatcher.js.src.html +1 -1
  123. package/docs/source/lib/goog/labs/useragent/browser.js.src.html +1 -1
  124. package/docs/source/lib/goog/labs/useragent/engine.js.src.html +1 -1
  125. package/docs/source/lib/goog/labs/useragent/util.js.src.html +1 -1
  126. package/docs/source/lib/goog/math/box.js.src.html +1 -1
  127. package/docs/source/lib/goog/math/coordinate.js.src.html +1 -1
  128. package/docs/source/lib/goog/math/math.js.src.html +1 -1
  129. package/docs/source/lib/goog/math/rect.js.src.html +1 -1
  130. package/docs/source/lib/goog/math/size.js.src.html +1 -1
  131. package/docs/source/lib/goog/net/wrapperxmlhttpfactory.js.src.html +1 -1
  132. package/docs/source/lib/goog/net/xhrlike.js.src.html +1 -1
  133. package/docs/source/lib/goog/net/xmlhttp.js.src.html +1 -1
  134. package/docs/source/lib/goog/net/xmlhttpfactory.js.src.html +1 -1
  135. package/docs/source/lib/goog/object/object.js.src.html +1 -1
  136. package/docs/source/lib/goog/reflect/reflect.js.src.html +1 -1
  137. package/docs/source/lib/goog/string/string.js.src.html +1 -1
  138. package/docs/source/lib/goog/structs/collection.js.src.html +1 -1
  139. package/docs/source/lib/goog/structs/map.js.src.html +1 -1
  140. package/docs/source/lib/goog/structs/set.js.src.html +1 -1
  141. package/docs/source/lib/goog/structs/structs.js.src.html +1 -1
  142. package/docs/source/lib/goog/style/style.js.src.html +1 -1
  143. package/docs/source/lib/goog/testing/asserts.js.src.html +1 -1
  144. package/docs/source/lib/goog/testing/asynctestcase.js.src.html +1 -1
  145. package/docs/source/lib/goog/testing/events/events.js.src.html +1 -1
  146. package/docs/source/lib/goog/testing/functionmock.js.src.html +1 -1
  147. package/docs/source/lib/goog/testing/jsunit.js.src.html +1 -1
  148. package/docs/source/lib/goog/testing/loosemock.js.src.html +1 -1
  149. package/docs/source/lib/goog/testing/mock.js.src.html +1 -1
  150. package/docs/source/lib/goog/testing/mockclock.js.src.html +1 -1
  151. package/docs/source/lib/goog/testing/mockcontrol.js.src.html +1 -1
  152. package/docs/source/lib/goog/testing/mockinterface.js.src.html +1 -1
  153. package/docs/source/lib/goog/testing/mockmatchers.js.src.html +1 -1
  154. package/docs/source/lib/goog/testing/objectpropertystring.js.src.html +1 -1
  155. package/docs/source/lib/goog/testing/propertyreplacer.js.src.html +1 -1
  156. package/docs/source/lib/goog/testing/recordfunction.js.src.html +1 -1
  157. package/docs/source/lib/goog/testing/stacktrace.js.src.html +1 -1
  158. package/docs/source/lib/goog/testing/strictmock.js.src.html +1 -1
  159. package/docs/source/lib/goog/testing/testcase.js.src.html +1 -1
  160. package/docs/source/lib/goog/testing/testrunner.js.src.html +1 -1
  161. package/docs/source/lib/goog/testing/watchers.js.src.html +1 -1
  162. package/docs/source/lib/goog/uri/uri.js.src.html +1 -1
  163. package/docs/source/lib/goog/uri/utils.js.src.html +1 -1
  164. package/docs/source/lib/goog/useragent/product.js.src.html +1 -1
  165. package/docs/source/lib/goog/useragent/product_isversion.js.src.html +1 -1
  166. package/docs/source/lib/goog/useragent/useragent.js.src.html +1 -1
  167. package/docs/source/lib/webdriver/abstractbuilder.js.src.html +1 -1
  168. package/docs/source/lib/webdriver/actionsequence.js.src.html +1 -1
  169. package/docs/source/lib/webdriver/builder.js.src.html +1 -1
  170. package/docs/source/lib/webdriver/button.js.src.html +1 -1
  171. package/docs/source/lib/webdriver/capabilities.js.src.html +1 -1
  172. package/docs/source/lib/webdriver/command.js.src.html +1 -1
  173. package/docs/source/lib/webdriver/events.js.src.html +1 -1
  174. package/docs/source/lib/webdriver/firefoxdomexecutor.js.src.html +1 -1
  175. package/docs/source/lib/webdriver/http/corsclient.js.src.html +1 -1
  176. package/docs/source/lib/webdriver/http/http.js.src.html +1 -1
  177. package/docs/source/lib/webdriver/http/xhrclient.js.src.html +1 -1
  178. package/docs/source/lib/webdriver/key.js.src.html +1 -1
  179. package/docs/source/lib/webdriver/locators.js.src.html +1 -1
  180. package/docs/source/lib/webdriver/logging.js.src.html +1 -1
  181. package/docs/source/lib/webdriver/process.js.src.html +1 -1
  182. package/docs/source/lib/webdriver/promise.js.src.html +1 -1
  183. package/docs/source/lib/webdriver/session.js.src.html +1 -1
  184. package/docs/source/lib/webdriver/stacktrace.js.src.html +1 -1
  185. package/docs/source/lib/webdriver/testing/asserts.js.src.html +1 -1
  186. package/docs/source/lib/webdriver/testing/testcase.js.src.html +1 -1
  187. package/docs/source/lib/webdriver/until.js.src.html +1 -0
  188. package/docs/source/lib/webdriver/webdriver.js.src.html +1 -1
  189. package/docs/source/net/index.js.src.html +1 -1
  190. package/docs/source/net/portprober.js.src.html +1 -1
  191. package/docs/source/phantomjs.js.src.html +1 -1
  192. package/docs/source/proxy.js.src.html +1 -1
  193. package/docs/source/remote/index.js.src.html +1 -1
  194. package/docs/source/testing/assert.js.src.html +1 -1
  195. package/docs/source/testing/index.js.src.html +1 -1
  196. package/docs/types.js +1 -1
  197. package/example/google_search.js +9 -17
  198. package/example/google_search_generator.js +6 -7
  199. package/example/google_search_test.js +10 -18
  200. package/example/parallel_flows.js +4 -7
  201. package/index.js +6 -0
  202. package/lib/firefox/webdriver.xpi +0 -0
  203. package/lib/goog/deps.js +7 -5
  204. package/lib/test/index.js +0 -8
  205. package/lib/webdriver/promise.js +263 -251
  206. package/lib/webdriver/stacktrace.js +15 -1
  207. package/lib/webdriver/test/promise_flow_test.js +82 -76
  208. package/lib/webdriver/test/promise_test.js +22 -62
  209. package/lib/webdriver/test/stacktrace_test.js +18 -0
  210. package/lib/webdriver/test/until_test.js +388 -0
  211. package/lib/webdriver/test/webdriver_test.js +41 -0
  212. package/lib/webdriver/until.js +408 -0
  213. package/lib/webdriver/webdriver.js +91 -29
  214. package/package.json +2 -2
  215. package/test/element_finding_test.js +6 -6
  216. package/test/http/util_test.js +4 -5
  217. package/test/page_loading_test.js +7 -7
  218. package/test/stale_element_test.js +2 -10
  219. package/testing/index.js +9 -22
package/docs/source/lib/atoms/error.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>error.js</title><link href="../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/atoms/error.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2010 WebDriver committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2010 Google Inc.<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>/**<tr><td><a name="l17" href="#l17">17</a><td> * @fileoverview Utilities for working with errors as defined by WebDriver&#39;s<tr><td><a name="l18" href="#l18">18</a><td> * wire protocol: http://code.google.com/p/selenium/wiki/JsonWireProtocol.<tr><td><a name="l19" href="#l19">19</a><td> */<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;bot.Error&#39;);<tr><td><a name="l22" href="#l22">22</a><td>goog.provide(&#39;bot.ErrorCode&#39;);<tr><td><a name="l23" href="#l23">23</a><td><tr><td><a name="l24" href="#l24">24</a><td><tr><td><a name="l25" href="#l25">25</a><td>/**<tr><td><a name="l26" href="#l26">26</a><td> * Error codes from the WebDriver wire protocol:<tr><td><a name="l27" href="#l27">27</a><td> * http://code.google.com/p/selenium/wiki/JsonWireProtocol#Response_Status_Codes<tr><td><a name="l28" href="#l28">28</a><td> *<tr><td><a name="l29" href="#l29">29</a><td> * @enum {number}<tr><td><a name="l30" href="#l30">30</a><td> */<tr><td><a name="l31" href="#l31">31</a><td>bot.ErrorCode = {<tr><td><a name="l32" href="#l32">32</a><td> SUCCESS: 0, // Included for completeness<tr><td><a name="l33" href="#l33">33</a><td><tr><td><a name="l34" href="#l34">34</a><td> NO_SUCH_ELEMENT: 7,<tr><td><a name="l35" href="#l35">35</a><td> NO_SUCH_FRAME: 8,<tr><td><a name="l36" href="#l36">36</a><td> UNKNOWN_COMMAND: 9,<tr><td><a name="l37" href="#l37">37</a><td> UNSUPPORTED_OPERATION: 9, // Alias.<tr><td><a name="l38" href="#l38">38</a><td> STALE_ELEMENT_REFERENCE: 10,<tr><td><a name="l39" href="#l39">39</a><td> ELEMENT_NOT_VISIBLE: 11,<tr><td><a name="l40" href="#l40">40</a><td> INVALID_ELEMENT_STATE: 12,<tr><td><a name="l41" href="#l41">41</a><td> UNKNOWN_ERROR: 13,<tr><td><a name="l42" href="#l42">42</a><td> ELEMENT_NOT_SELECTABLE: 15,<tr><td><a name="l43" href="#l43">43</a><td> JAVASCRIPT_ERROR: 17,<tr><td><a name="l44" href="#l44">44</a><td> XPATH_LOOKUP_ERROR: 19,<tr><td><a name="l45" href="#l45">45</a><td> TIMEOUT: 21,<tr><td><a name="l46" href="#l46">46</a><td> NO_SUCH_WINDOW: 23,<tr><td><a name="l47" href="#l47">47</a><td> INVALID_COOKIE_DOMAIN: 24,<tr><td><a name="l48" href="#l48">48</a><td> UNABLE_TO_SET_COOKIE: 25,<tr><td><a name="l49" href="#l49">49</a><td> /** @deprecated */<tr><td><a name="l50" href="#l50">50</a><td> MODAL_DIALOG_OPENED: 26,<tr><td><a name="l51" href="#l51">51</a><td> UNEXPECTED_ALERT_OPEN: 26,<tr><td><a name="l52" href="#l52">52</a><td> NO_SUCH_ALERT: 27,<tr><td><a name="l53" href="#l53">53</a><td> /** @deprecated */<tr><td><a name="l54" href="#l54">54</a><td> NO_MODAL_DIALOG_OPEN: 27,<tr><td><a name="l55" href="#l55">55</a><td> SCRIPT_TIMEOUT: 28,<tr><td><a name="l56" href="#l56">56</a><td> INVALID_ELEMENT_COORDINATES: 29,<tr><td><a name="l57" href="#l57">57</a><td> IME_NOT_AVAILABLE: 30,<tr><td><a name="l58" href="#l58">58</a><td> IME_ENGINE_ACTIVATION_FAILED: 31,<tr><td><a name="l59" href="#l59">59</a><td> INVALID_SELECTOR_ERROR: 32,<tr><td><a name="l60" href="#l60">60</a><td> SESSION_NOT_CREATED: 33,<tr><td><a name="l61" href="#l61">61</a><td> MOVE_TARGET_OUT_OF_BOUNDS: 34,<tr><td><a name="l62" href="#l62">62</a><td> SQL_DATABASE_ERROR: 35,<tr><td><a name="l63" href="#l63">63</a><td> INVALID_XPATH_SELECTOR: 51,<tr><td><a name="l64" href="#l64">64</a><td> INVALID_XPATH_SELECTOR_RETURN_TYPE: 52,<tr><td><a name="l65" href="#l65">65</a><td> // The following error codes are derived straight from HTTP return codes.<tr><td><a name="l66" href="#l66">66</a><td> METHOD_NOT_ALLOWED: 405<tr><td><a name="l67" href="#l67">67</a><td>};<tr><td><a name="l68" href="#l68">68</a><td><tr><td><a name="l69" href="#l69">69</a><td><tr><td><a name="l70" href="#l70">70</a><td><tr><td><a name="l71" href="#l71">71</a><td>/**<tr><td><a name="l72" href="#l72">72</a><td> * Error extension that includes error status codes from the WebDriver wire<tr><td><a name="l73" href="#l73">73</a><td> * protocol:<tr><td><a name="l74" href="#l74">74</a><td> * http://code.google.com/p/selenium/wiki/JsonWireProtocol#Response_Status_Codes<tr><td><a name="l75" href="#l75">75</a><td> *<tr><td><a name="l76" href="#l76">76</a><td> * @param {!bot.ErrorCode} code The error&#39;s status code.<tr><td><a name="l77" href="#l77">77</a><td> * @param {string=} opt_message Optional error message.<tr><td><a name="l78" href="#l78">78</a><td> * @constructor<tr><td><a name="l79" href="#l79">79</a><td> * @extends {Error}<tr><td><a name="l80" href="#l80">80</a><td> */<tr><td><a name="l81" href="#l81">81</a><td>bot.Error = function(code, opt_message) {<tr><td><a name="l82" href="#l82">82</a><td><tr><td><a name="l83" href="#l83">83</a><td> /**<tr><td><a name="l84" href="#l84">84</a><td> * This error&#39;s status code.<tr><td><a name="l85" href="#l85">85</a><td> * @type {!bot.ErrorCode}<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td> this.code = code;<tr><td><a name="l88" href="#l88">88</a><td><tr><td><a name="l89" href="#l89">89</a><td> /** @type {string} */<tr><td><a name="l90" href="#l90">90</a><td> this.state =<tr><td><a name="l91" href="#l91">91</a><td> bot.Error.CODE_TO_STATE_[code] || bot.Error.State.UNKNOWN_ERROR;<tr><td><a name="l92" href="#l92">92</a><td><tr><td><a name="l93" href="#l93">93</a><td> /** @override */<tr><td><a name="l94" href="#l94">94</a><td> this.message = opt_message || &#39;&#39;;<tr><td><a name="l95" href="#l95">95</a><td><tr><td><a name="l96" href="#l96">96</a><td> var name = this.state.replace(/((?:^|\s+)[a-z])/g, function(str) {<tr><td><a name="l97" href="#l97">97</a><td> // IE&lt;9 does not support String#trim(). Also, IE does not include 0xa0<tr><td><a name="l98" href="#l98">98</a><td> // (the non-breaking-space) in the \s character class, so we have to<tr><td><a name="l99" href="#l99">99</a><td> // explicitly include it.<tr><td><a name="l100" href="#l100">100</a><td> return str.toUpperCase().replace(/^[\s\xa0]+/g, &#39;&#39;);<tr><td><a name="l101" href="#l101">101</a><td> });<tr><td><a name="l102" href="#l102">102</a><td><tr><td><a name="l103" href="#l103">103</a><td> var l = name.length - &#39;Error&#39;.length;<tr><td><a name="l104" href="#l104">104</a><td> if (l &lt; 0 || name.indexOf(&#39;Error&#39;, l) != l) {<tr><td><a name="l105" href="#l105">105</a><td> name += &#39;Error&#39;;<tr><td><a name="l106" href="#l106">106</a><td> }<tr><td><a name="l107" href="#l107">107</a><td><tr><td><a name="l108" href="#l108">108</a><td> /** @override */<tr><td><a name="l109" href="#l109">109</a><td> this.name = name;<tr><td><a name="l110" href="#l110">110</a><td><tr><td><a name="l111" href="#l111">111</a><td> // Generate a stacktrace for our custom error; ensure the error has our<tr><td><a name="l112" href="#l112">112</a><td> // custom name and message so the stack prints correctly in all browsers.<tr><td><a name="l113" href="#l113">113</a><td> var template = new Error(this.message);<tr><td><a name="l114" href="#l114">114</a><td> template.name = this.name;<tr><td><a name="l115" href="#l115">115</a><td><tr><td><a name="l116" href="#l116">116</a><td> /** @override */<tr><td><a name="l117" href="#l117">117</a><td> this.stack = template.stack || &#39;&#39;;<tr><td><a name="l118" href="#l118">118</a><td>};<tr><td><a name="l119" href="#l119">119</a><td>goog.inherits(bot.Error, Error);<tr><td><a name="l120" href="#l120">120</a><td><tr><td><a name="l121" href="#l121">121</a><td><tr><td><a name="l122" href="#l122">122</a><td>/**<tr><td><a name="l123" href="#l123">123</a><td> * Status strings enumerated in the W3C WebDriver working draft.<tr><td><a name="l124" href="#l124">124</a><td> * @enum {string}<tr><td><a name="l125" href="#l125">125</a><td> * @see http://www.w3.org/TR/webdriver/#status-codes<tr><td><a name="l126" href="#l126">126</a><td> */<tr><td><a name="l127" href="#l127">127</a><td>bot.Error.State = {<tr><td><a name="l128" href="#l128">128</a><td> ELEMENT_NOT_SELECTABLE: &#39;element not selectable&#39;,<tr><td><a name="l129" href="#l129">129</a><td> ELEMENT_NOT_VISIBLE: &#39;element not visible&#39;,<tr><td><a name="l130" href="#l130">130</a><td> IME_ENGINE_ACTIVATION_FAILED: &#39;ime engine activation failed&#39;,<tr><td><a name="l131" href="#l131">131</a><td> IME_NOT_AVAILABLE: &#39;ime not available&#39;,<tr><td><a name="l132" href="#l132">132</a><td> INVALID_COOKIE_DOMAIN: &#39;invalid cookie domain&#39;,<tr><td><a name="l133" href="#l133">133</a><td> INVALID_ELEMENT_COORDINATES: &#39;invalid element coordinates&#39;,<tr><td><a name="l134" href="#l134">134</a><td> INVALID_ELEMENT_STATE: &#39;invalid element state&#39;,<tr><td><a name="l135" href="#l135">135</a><td> INVALID_SELECTOR: &#39;invalid selector&#39;,<tr><td><a name="l136" href="#l136">136</a><td> JAVASCRIPT_ERROR: &#39;javascript error&#39;,<tr><td><a name="l137" href="#l137">137</a><td> MOVE_TARGET_OUT_OF_BOUNDS: &#39;move target out of bounds&#39;,<tr><td><a name="l138" href="#l138">138</a><td> NO_SUCH_ALERT: &#39;no such alert&#39;,<tr><td><a name="l139" href="#l139">139</a><td> NO_SUCH_DOM: &#39;no such dom&#39;,<tr><td><a name="l140" href="#l140">140</a><td> NO_SUCH_ELEMENT: &#39;no such element&#39;,<tr><td><a name="l141" href="#l141">141</a><td> NO_SUCH_FRAME: &#39;no such frame&#39;,<tr><td><a name="l142" href="#l142">142</a><td> NO_SUCH_WINDOW: &#39;no such window&#39;,<tr><td><a name="l143" href="#l143">143</a><td> SCRIPT_TIMEOUT: &#39;script timeout&#39;,<tr><td><a name="l144" href="#l144">144</a><td> SESSION_NOT_CREATED: &#39;session not created&#39;,<tr><td><a name="l145" href="#l145">145</a><td> STALE_ELEMENT_REFERENCE: &#39;stale element reference&#39;,<tr><td><a name="l146" href="#l146">146</a><td> SUCCESS: &#39;success&#39;,<tr><td><a name="l147" href="#l147">147</a><td> TIMEOUT: &#39;timeout&#39;,<tr><td><a name="l148" href="#l148">148</a><td> UNABLE_TO_SET_COOKIE: &#39;unable to set cookie&#39;,<tr><td><a name="l149" href="#l149">149</a><td> UNEXPECTED_ALERT_OPEN: &#39;unexpected alert open&#39;,<tr><td><a name="l150" href="#l150">150</a><td> UNKNOWN_COMMAND: &#39;unknown command&#39;,<tr><td><a name="l151" href="#l151">151</a><td> UNKNOWN_ERROR: &#39;unknown error&#39;,<tr><td><a name="l152" href="#l152">152</a><td> UNSUPPORTED_OPERATION: &#39;unsupported operation&#39;<tr><td><a name="l153" href="#l153">153</a><td>};<tr><td><a name="l154" href="#l154">154</a><td><tr><td><a name="l155" href="#l155">155</a><td><tr><td><a name="l156" href="#l156">156</a><td>/**<tr><td><a name="l157" href="#l157">157</a><td> * A map of error codes to state string.<tr><td><a name="l158" href="#l158">158</a><td> * @private {!Object.&lt;bot.ErrorCode, bot.Error.State&gt;}<tr><td><a name="l159" href="#l159">159</a><td> */<tr><td><a name="l160" href="#l160">160</a><td>bot.Error.CODE_TO_STATE_ = {};<tr><td><a name="l161" href="#l161">161</a><td>goog.scope(function() {<tr><td><a name="l162" href="#l162">162</a><td> var map = bot.Error.CODE_TO_STATE_;<tr><td><a name="l163" href="#l163">163</a><td> var code = bot.ErrorCode;<tr><td><a name="l164" href="#l164">164</a><td> var state = bot.Error.State;<tr><td><a name="l165" href="#l165">165</a><td><tr><td><a name="l166" href="#l166">166</a><td> map[code.ELEMENT_NOT_SELECTABLE] = state.ELEMENT_NOT_SELECTABLE;<tr><td><a name="l167" href="#l167">167</a><td> map[code.ELEMENT_NOT_VISIBLE] = state.ELEMENT_NOT_VISIBLE;<tr><td><a name="l168" href="#l168">168</a><td> map[code.IME_ENGINE_ACTIVATION_FAILED] = state.IME_ENGINE_ACTIVATION_FAILED;<tr><td><a name="l169" href="#l169">169</a><td> map[code.IME_NOT_AVAILABLE] = state.IME_NOT_AVAILABLE;<tr><td><a name="l170" href="#l170">170</a><td> map[code.INVALID_COOKIE_DOMAIN] = state.INVALID_COOKIE_DOMAIN;<tr><td><a name="l171" href="#l171">171</a><td> map[code.INVALID_ELEMENT_COORDINATES] = state.INVALID_ELEMENT_COORDINATES;<tr><td><a name="l172" href="#l172">172</a><td> map[code.INVALID_ELEMENT_STATE] = state.INVALID_ELEMENT_STATE;<tr><td><a name="l173" href="#l173">173</a><td> map[code.INVALID_SELECTOR_ERROR] = state.INVALID_SELECTOR;<tr><td><a name="l174" href="#l174">174</a><td> map[code.INVALID_XPATH_SELECTOR] = state.INVALID_SELECTOR;<tr><td><a name="l175" href="#l175">175</a><td> map[code.INVALID_XPATH_SELECTOR_RETURN_TYPE] = state.INVALID_SELECTOR;<tr><td><a name="l176" href="#l176">176</a><td> map[code.JAVASCRIPT_ERROR] = state.JAVASCRIPT_ERROR;<tr><td><a name="l177" href="#l177">177</a><td> map[code.METHOD_NOT_ALLOWED] = state.UNSUPPORTED_OPERATION;<tr><td><a name="l178" href="#l178">178</a><td> map[code.MOVE_TARGET_OUT_OF_BOUNDS] = state.MOVE_TARGET_OUT_OF_BOUNDS;<tr><td><a name="l179" href="#l179">179</a><td> map[code.NO_MODAL_DIALOG_OPEN] = state.NO_SUCH_ALERT;<tr><td><a name="l180" href="#l180">180</a><td> map[code.NO_SUCH_ALERT] = state.NO_SUCH_ALERT;<tr><td><a name="l181" href="#l181">181</a><td> map[code.NO_SUCH_ELEMENT] = state.NO_SUCH_ELEMENT;<tr><td><a name="l182" href="#l182">182</a><td> map[code.NO_SUCH_FRAME] = state.NO_SUCH_FRAME;<tr><td><a name="l183" href="#l183">183</a><td> map[code.NO_SUCH_WINDOW] = state.NO_SUCH_WINDOW;<tr><td><a name="l184" href="#l184">184</a><td> map[code.SCRIPT_TIMEOUT] = state.SCRIPT_TIMEOUT;<tr><td><a name="l185" href="#l185">185</a><td> map[code.SESSION_NOT_CREATED] = state.SESSION_NOT_CREATED;<tr><td><a name="l186" href="#l186">186</a><td> map[code.STALE_ELEMENT_REFERENCE] = state.STALE_ELEMENT_REFERENCE;<tr><td><a name="l187" href="#l187">187</a><td> map[code.SUCCESS] = state.SUCCESS;<tr><td><a name="l188" href="#l188">188</a><td> map[code.TIMEOUT] = state.TIMEOUT;<tr><td><a name="l189" href="#l189">189</a><td> map[code.UNABLE_TO_SET_COOKIE] = state.UNABLE_TO_SET_COOKIE;<tr><td><a name="l190" href="#l190">190</a><td> map[code.MODAL_DIALOG_OPENED] = state.UNEXPECTED_ALERT_OPEN;<tr><td><a name="l191" href="#l191">191</a><td> map[code.UNEXPECTED_ALERT_OPEN] = state.UNEXPECTED_ALERT_OPEN<tr><td><a name="l192" href="#l192">192</a><td> map[code.UNKNOWN_ERROR] = state.UNKNOWN_ERROR;<tr><td><a name="l193" href="#l193">193</a><td> map[code.UNSUPPORTED_OPERATION] = state.UNKNOWN_COMMAND;<tr><td><a name="l194" href="#l194">194</a><td>}); // goog.scope<tr><td><a name="l195" href="#l195">195</a><td><tr><td><a name="l196" href="#l196">196</a><td><tr><td><a name="l197" href="#l197">197</a><td>/**<tr><td><a name="l198" href="#l198">198</a><td> * Flag used for duck-typing when this code is embedded in a Firefox extension.<tr><td><a name="l199" href="#l199">199</a><td> * This is required since an Error thrown in one component and then reported<tr><td><a name="l200" href="#l200">200</a><td> * to another will fail instanceof checks in the second component.<tr><td><a name="l201" href="#l201">201</a><td> * @type {boolean}<tr><td><a name="l202" href="#l202">202</a><td> */<tr><td><a name="l203" href="#l203">203</a><td>bot.Error.prototype.isAutomationError = true;<tr><td><a name="l204" href="#l204">204</a><td><tr><td><a name="l205" href="#l205">205</a><td><tr><td><a name="l206" href="#l206">206</a><td>if (goog.DEBUG) {<tr><td><a name="l207" href="#l207">207</a><td> /** @return {string} The string representation of this error. */<tr><td><a name="l208" href="#l208">208</a><td> bot.Error.prototype.toString = function() {<tr><td><a name="l209" href="#l209">209</a><td> return this.name + &#39;: &#39; + this.message;<tr><td><a name="l210" href="#l210">210</a><td> };<tr><td><a name="l211" href="#l211">211</a><td>}</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../types.js"></script><script src="../../../dossier.js"></script>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>error.js</title><link href="../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/atoms/error.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2010 WebDriver committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2010 Google Inc.<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>/**<tr><td><a name="l17" href="#l17">17</a><td> * @fileoverview Utilities for working with errors as defined by WebDriver&#39;s<tr><td><a name="l18" href="#l18">18</a><td> * wire protocol: http://code.google.com/p/selenium/wiki/JsonWireProtocol.<tr><td><a name="l19" href="#l19">19</a><td> */<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;bot.Error&#39;);<tr><td><a name="l22" href="#l22">22</a><td>goog.provide(&#39;bot.ErrorCode&#39;);<tr><td><a name="l23" href="#l23">23</a><td><tr><td><a name="l24" href="#l24">24</a><td><tr><td><a name="l25" href="#l25">25</a><td>/**<tr><td><a name="l26" href="#l26">26</a><td> * Error codes from the WebDriver wire protocol:<tr><td><a name="l27" href="#l27">27</a><td> * http://code.google.com/p/selenium/wiki/JsonWireProtocol#Response_Status_Codes<tr><td><a name="l28" href="#l28">28</a><td> *<tr><td><a name="l29" href="#l29">29</a><td> * @enum {number}<tr><td><a name="l30" href="#l30">30</a><td> */<tr><td><a name="l31" href="#l31">31</a><td>bot.ErrorCode = {<tr><td><a name="l32" href="#l32">32</a><td> SUCCESS: 0, // Included for completeness<tr><td><a name="l33" href="#l33">33</a><td><tr><td><a name="l34" href="#l34">34</a><td> NO_SUCH_ELEMENT: 7,<tr><td><a name="l35" href="#l35">35</a><td> NO_SUCH_FRAME: 8,<tr><td><a name="l36" href="#l36">36</a><td> UNKNOWN_COMMAND: 9,<tr><td><a name="l37" href="#l37">37</a><td> UNSUPPORTED_OPERATION: 9, // Alias.<tr><td><a name="l38" href="#l38">38</a><td> STALE_ELEMENT_REFERENCE: 10,<tr><td><a name="l39" href="#l39">39</a><td> ELEMENT_NOT_VISIBLE: 11,<tr><td><a name="l40" href="#l40">40</a><td> INVALID_ELEMENT_STATE: 12,<tr><td><a name="l41" href="#l41">41</a><td> UNKNOWN_ERROR: 13,<tr><td><a name="l42" href="#l42">42</a><td> ELEMENT_NOT_SELECTABLE: 15,<tr><td><a name="l43" href="#l43">43</a><td> JAVASCRIPT_ERROR: 17,<tr><td><a name="l44" href="#l44">44</a><td> XPATH_LOOKUP_ERROR: 19,<tr><td><a name="l45" href="#l45">45</a><td> TIMEOUT: 21,<tr><td><a name="l46" href="#l46">46</a><td> NO_SUCH_WINDOW: 23,<tr><td><a name="l47" href="#l47">47</a><td> INVALID_COOKIE_DOMAIN: 24,<tr><td><a name="l48" href="#l48">48</a><td> UNABLE_TO_SET_COOKIE: 25,<tr><td><a name="l49" href="#l49">49</a><td> /** @deprecated */<tr><td><a name="l50" href="#l50">50</a><td> MODAL_DIALOG_OPENED: 26,<tr><td><a name="l51" href="#l51">51</a><td> UNEXPECTED_ALERT_OPEN: 26,<tr><td><a name="l52" href="#l52">52</a><td> NO_SUCH_ALERT: 27,<tr><td><a name="l53" href="#l53">53</a><td> /** @deprecated */<tr><td><a name="l54" href="#l54">54</a><td> NO_MODAL_DIALOG_OPEN: 27,<tr><td><a name="l55" href="#l55">55</a><td> SCRIPT_TIMEOUT: 28,<tr><td><a name="l56" href="#l56">56</a><td> INVALID_ELEMENT_COORDINATES: 29,<tr><td><a name="l57" href="#l57">57</a><td> IME_NOT_AVAILABLE: 30,<tr><td><a name="l58" href="#l58">58</a><td> IME_ENGINE_ACTIVATION_FAILED: 31,<tr><td><a name="l59" href="#l59">59</a><td> INVALID_SELECTOR_ERROR: 32,<tr><td><a name="l60" href="#l60">60</a><td> SESSION_NOT_CREATED: 33,<tr><td><a name="l61" href="#l61">61</a><td> MOVE_TARGET_OUT_OF_BOUNDS: 34,<tr><td><a name="l62" href="#l62">62</a><td> SQL_DATABASE_ERROR: 35,<tr><td><a name="l63" href="#l63">63</a><td> INVALID_XPATH_SELECTOR: 51,<tr><td><a name="l64" href="#l64">64</a><td> INVALID_XPATH_SELECTOR_RETURN_TYPE: 52,<tr><td><a name="l65" href="#l65">65</a><td> // The following error codes are derived straight from HTTP return codes.<tr><td><a name="l66" href="#l66">66</a><td> METHOD_NOT_ALLOWED: 405<tr><td><a name="l67" href="#l67">67</a><td>};<tr><td><a name="l68" href="#l68">68</a><td><tr><td><a name="l69" href="#l69">69</a><td><tr><td><a name="l70" href="#l70">70</a><td><tr><td><a name="l71" href="#l71">71</a><td>/**<tr><td><a name="l72" href="#l72">72</a><td> * Error extension that includes error status codes from the WebDriver wire<tr><td><a name="l73" href="#l73">73</a><td> * protocol:<tr><td><a name="l74" href="#l74">74</a><td> * http://code.google.com/p/selenium/wiki/JsonWireProtocol#Response_Status_Codes<tr><td><a name="l75" href="#l75">75</a><td> *<tr><td><a name="l76" href="#l76">76</a><td> * @param {!bot.ErrorCode} code The error&#39;s status code.<tr><td><a name="l77" href="#l77">77</a><td> * @param {string=} opt_message Optional error message.<tr><td><a name="l78" href="#l78">78</a><td> * @constructor<tr><td><a name="l79" href="#l79">79</a><td> * @extends {Error}<tr><td><a name="l80" href="#l80">80</a><td> */<tr><td><a name="l81" href="#l81">81</a><td>bot.Error = function(code, opt_message) {<tr><td><a name="l82" href="#l82">82</a><td><tr><td><a name="l83" href="#l83">83</a><td> /**<tr><td><a name="l84" href="#l84">84</a><td> * This error&#39;s status code.<tr><td><a name="l85" href="#l85">85</a><td> * @type {!bot.ErrorCode}<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td> this.code = code;<tr><td><a name="l88" href="#l88">88</a><td><tr><td><a name="l89" href="#l89">89</a><td> /** @type {string} */<tr><td><a name="l90" href="#l90">90</a><td> this.state =<tr><td><a name="l91" href="#l91">91</a><td> bot.Error.CODE_TO_STATE_[code] || bot.Error.State.UNKNOWN_ERROR;<tr><td><a name="l92" href="#l92">92</a><td><tr><td><a name="l93" href="#l93">93</a><td> /** @override */<tr><td><a name="l94" href="#l94">94</a><td> this.message = opt_message || &#39;&#39;;<tr><td><a name="l95" href="#l95">95</a><td><tr><td><a name="l96" href="#l96">96</a><td> var name = this.state.replace(/((?:^|\s+)[a-z])/g, function(str) {<tr><td><a name="l97" href="#l97">97</a><td> // IE&lt;9 does not support String#trim(). Also, IE does not include 0xa0<tr><td><a name="l98" href="#l98">98</a><td> // (the non-breaking-space) in the \s character class, so we have to<tr><td><a name="l99" href="#l99">99</a><td> // explicitly include it.<tr><td><a name="l100" href="#l100">100</a><td> return str.toUpperCase().replace(/^[\s\xa0]+/g, &#39;&#39;);<tr><td><a name="l101" href="#l101">101</a><td> });<tr><td><a name="l102" href="#l102">102</a><td><tr><td><a name="l103" href="#l103">103</a><td> var l = name.length - &#39;Error&#39;.length;<tr><td><a name="l104" href="#l104">104</a><td> if (l &lt; 0 || name.indexOf(&#39;Error&#39;, l) != l) {<tr><td><a name="l105" href="#l105">105</a><td> name += &#39;Error&#39;;<tr><td><a name="l106" href="#l106">106</a><td> }<tr><td><a name="l107" href="#l107">107</a><td><tr><td><a name="l108" href="#l108">108</a><td> /** @override */<tr><td><a name="l109" href="#l109">109</a><td> this.name = name;<tr><td><a name="l110" href="#l110">110</a><td><tr><td><a name="l111" href="#l111">111</a><td> // Generate a stacktrace for our custom error; ensure the error has our<tr><td><a name="l112" href="#l112">112</a><td> // custom name and message so the stack prints correctly in all browsers.<tr><td><a name="l113" href="#l113">113</a><td> var template = new Error(this.message);<tr><td><a name="l114" href="#l114">114</a><td> template.name = this.name;<tr><td><a name="l115" href="#l115">115</a><td><tr><td><a name="l116" href="#l116">116</a><td> /** @override */<tr><td><a name="l117" href="#l117">117</a><td> this.stack = template.stack || &#39;&#39;;<tr><td><a name="l118" href="#l118">118</a><td>};<tr><td><a name="l119" href="#l119">119</a><td>goog.inherits(bot.Error, Error);<tr><td><a name="l120" href="#l120">120</a><td><tr><td><a name="l121" href="#l121">121</a><td><tr><td><a name="l122" href="#l122">122</a><td>/**<tr><td><a name="l123" href="#l123">123</a><td> * Status strings enumerated in the W3C WebDriver working draft.<tr><td><a name="l124" href="#l124">124</a><td> * @enum {string}<tr><td><a name="l125" href="#l125">125</a><td> * @see http://www.w3.org/TR/webdriver/#status-codes<tr><td><a name="l126" href="#l126">126</a><td> */<tr><td><a name="l127" href="#l127">127</a><td>bot.Error.State = {<tr><td><a name="l128" href="#l128">128</a><td> ELEMENT_NOT_SELECTABLE: &#39;element not selectable&#39;,<tr><td><a name="l129" href="#l129">129</a><td> ELEMENT_NOT_VISIBLE: &#39;element not visible&#39;,<tr><td><a name="l130" href="#l130">130</a><td> IME_ENGINE_ACTIVATION_FAILED: &#39;ime engine activation failed&#39;,<tr><td><a name="l131" href="#l131">131</a><td> IME_NOT_AVAILABLE: &#39;ime not available&#39;,<tr><td><a name="l132" href="#l132">132</a><td> INVALID_COOKIE_DOMAIN: &#39;invalid cookie domain&#39;,<tr><td><a name="l133" href="#l133">133</a><td> INVALID_ELEMENT_COORDINATES: &#39;invalid element coordinates&#39;,<tr><td><a name="l134" href="#l134">134</a><td> INVALID_ELEMENT_STATE: &#39;invalid element state&#39;,<tr><td><a name="l135" href="#l135">135</a><td> INVALID_SELECTOR: &#39;invalid selector&#39;,<tr><td><a name="l136" href="#l136">136</a><td> JAVASCRIPT_ERROR: &#39;javascript error&#39;,<tr><td><a name="l137" href="#l137">137</a><td> MOVE_TARGET_OUT_OF_BOUNDS: &#39;move target out of bounds&#39;,<tr><td><a name="l138" href="#l138">138</a><td> NO_SUCH_ALERT: &#39;no such alert&#39;,<tr><td><a name="l139" href="#l139">139</a><td> NO_SUCH_DOM: &#39;no such dom&#39;,<tr><td><a name="l140" href="#l140">140</a><td> NO_SUCH_ELEMENT: &#39;no such element&#39;,<tr><td><a name="l141" href="#l141">141</a><td> NO_SUCH_FRAME: &#39;no such frame&#39;,<tr><td><a name="l142" href="#l142">142</a><td> NO_SUCH_WINDOW: &#39;no such window&#39;,<tr><td><a name="l143" href="#l143">143</a><td> SCRIPT_TIMEOUT: &#39;script timeout&#39;,<tr><td><a name="l144" href="#l144">144</a><td> SESSION_NOT_CREATED: &#39;session not created&#39;,<tr><td><a name="l145" href="#l145">145</a><td> STALE_ELEMENT_REFERENCE: &#39;stale element reference&#39;,<tr><td><a name="l146" href="#l146">146</a><td> SUCCESS: &#39;success&#39;,<tr><td><a name="l147" href="#l147">147</a><td> TIMEOUT: &#39;timeout&#39;,<tr><td><a name="l148" href="#l148">148</a><td> UNABLE_TO_SET_COOKIE: &#39;unable to set cookie&#39;,<tr><td><a name="l149" href="#l149">149</a><td> UNEXPECTED_ALERT_OPEN: &#39;unexpected alert open&#39;,<tr><td><a name="l150" href="#l150">150</a><td> UNKNOWN_COMMAND: &#39;unknown command&#39;,<tr><td><a name="l151" href="#l151">151</a><td> UNKNOWN_ERROR: &#39;unknown error&#39;,<tr><td><a name="l152" href="#l152">152</a><td> UNSUPPORTED_OPERATION: &#39;unsupported operation&#39;<tr><td><a name="l153" href="#l153">153</a><td>};<tr><td><a name="l154" href="#l154">154</a><td><tr><td><a name="l155" href="#l155">155</a><td><tr><td><a name="l156" href="#l156">156</a><td>/**<tr><td><a name="l157" href="#l157">157</a><td> * A map of error codes to state string.<tr><td><a name="l158" href="#l158">158</a><td> * @private {!Object.&lt;bot.ErrorCode, bot.Error.State&gt;}<tr><td><a name="l159" href="#l159">159</a><td> */<tr><td><a name="l160" href="#l160">160</a><td>bot.Error.CODE_TO_STATE_ = {};<tr><td><a name="l161" href="#l161">161</a><td>goog.scope(function() {<tr><td><a name="l162" href="#l162">162</a><td> var map = bot.Error.CODE_TO_STATE_;<tr><td><a name="l163" href="#l163">163</a><td> var code = bot.ErrorCode;<tr><td><a name="l164" href="#l164">164</a><td> var state = bot.Error.State;<tr><td><a name="l165" href="#l165">165</a><td><tr><td><a name="l166" href="#l166">166</a><td> map[code.ELEMENT_NOT_SELECTABLE] = state.ELEMENT_NOT_SELECTABLE;<tr><td><a name="l167" href="#l167">167</a><td> map[code.ELEMENT_NOT_VISIBLE] = state.ELEMENT_NOT_VISIBLE;<tr><td><a name="l168" href="#l168">168</a><td> map[code.IME_ENGINE_ACTIVATION_FAILED] = state.IME_ENGINE_ACTIVATION_FAILED;<tr><td><a name="l169" href="#l169">169</a><td> map[code.IME_NOT_AVAILABLE] = state.IME_NOT_AVAILABLE;<tr><td><a name="l170" href="#l170">170</a><td> map[code.INVALID_COOKIE_DOMAIN] = state.INVALID_COOKIE_DOMAIN;<tr><td><a name="l171" href="#l171">171</a><td> map[code.INVALID_ELEMENT_COORDINATES] = state.INVALID_ELEMENT_COORDINATES;<tr><td><a name="l172" href="#l172">172</a><td> map[code.INVALID_ELEMENT_STATE] = state.INVALID_ELEMENT_STATE;<tr><td><a name="l173" href="#l173">173</a><td> map[code.INVALID_SELECTOR_ERROR] = state.INVALID_SELECTOR;<tr><td><a name="l174" href="#l174">174</a><td> map[code.INVALID_XPATH_SELECTOR] = state.INVALID_SELECTOR;<tr><td><a name="l175" href="#l175">175</a><td> map[code.INVALID_XPATH_SELECTOR_RETURN_TYPE] = state.INVALID_SELECTOR;<tr><td><a name="l176" href="#l176">176</a><td> map[code.JAVASCRIPT_ERROR] = state.JAVASCRIPT_ERROR;<tr><td><a name="l177" href="#l177">177</a><td> map[code.METHOD_NOT_ALLOWED] = state.UNSUPPORTED_OPERATION;<tr><td><a name="l178" href="#l178">178</a><td> map[code.MOVE_TARGET_OUT_OF_BOUNDS] = state.MOVE_TARGET_OUT_OF_BOUNDS;<tr><td><a name="l179" href="#l179">179</a><td> map[code.NO_MODAL_DIALOG_OPEN] = state.NO_SUCH_ALERT;<tr><td><a name="l180" href="#l180">180</a><td> map[code.NO_SUCH_ALERT] = state.NO_SUCH_ALERT;<tr><td><a name="l181" href="#l181">181</a><td> map[code.NO_SUCH_ELEMENT] = state.NO_SUCH_ELEMENT;<tr><td><a name="l182" href="#l182">182</a><td> map[code.NO_SUCH_FRAME] = state.NO_SUCH_FRAME;<tr><td><a name="l183" href="#l183">183</a><td> map[code.NO_SUCH_WINDOW] = state.NO_SUCH_WINDOW;<tr><td><a name="l184" href="#l184">184</a><td> map[code.SCRIPT_TIMEOUT] = state.SCRIPT_TIMEOUT;<tr><td><a name="l185" href="#l185">185</a><td> map[code.SESSION_NOT_CREATED] = state.SESSION_NOT_CREATED;<tr><td><a name="l186" href="#l186">186</a><td> map[code.STALE_ELEMENT_REFERENCE] = state.STALE_ELEMENT_REFERENCE;<tr><td><a name="l187" href="#l187">187</a><td> map[code.SUCCESS] = state.SUCCESS;<tr><td><a name="l188" href="#l188">188</a><td> map[code.TIMEOUT] = state.TIMEOUT;<tr><td><a name="l189" href="#l189">189</a><td> map[code.UNABLE_TO_SET_COOKIE] = state.UNABLE_TO_SET_COOKIE;<tr><td><a name="l190" href="#l190">190</a><td> map[code.MODAL_DIALOG_OPENED] = state.UNEXPECTED_ALERT_OPEN;<tr><td><a name="l191" href="#l191">191</a><td> map[code.UNEXPECTED_ALERT_OPEN] = state.UNEXPECTED_ALERT_OPEN<tr><td><a name="l192" href="#l192">192</a><td> map[code.UNKNOWN_ERROR] = state.UNKNOWN_ERROR;<tr><td><a name="l193" href="#l193">193</a><td> map[code.UNSUPPORTED_OPERATION] = state.UNKNOWN_COMMAND;<tr><td><a name="l194" href="#l194">194</a><td>}); // goog.scope<tr><td><a name="l195" href="#l195">195</a><td><tr><td><a name="l196" href="#l196">196</a><td><tr><td><a name="l197" href="#l197">197</a><td>/**<tr><td><a name="l198" href="#l198">198</a><td> * Flag used for duck-typing when this code is embedded in a Firefox extension.<tr><td><a name="l199" href="#l199">199</a><td> * This is required since an Error thrown in one component and then reported<tr><td><a name="l200" href="#l200">200</a><td> * to another will fail instanceof checks in the second component.<tr><td><a name="l201" href="#l201">201</a><td> * @type {boolean}<tr><td><a name="l202" href="#l202">202</a><td> */<tr><td><a name="l203" href="#l203">203</a><td>bot.Error.prototype.isAutomationError = true;<tr><td><a name="l204" href="#l204">204</a><td><tr><td><a name="l205" href="#l205">205</a><td><tr><td><a name="l206" href="#l206">206</a><td>if (goog.DEBUG) {<tr><td><a name="l207" href="#l207">207</a><td> /** @return {string} The string representation of this error. */<tr><td><a name="l208" href="#l208">208</a><td> bot.Error.prototype.toString = function() {<tr><td><a name="l209" href="#l209">209</a><td> return this.name + &#39;: &#39; + this.message;<tr><td><a name="l210" href="#l210">210</a><td> };<tr><td><a name="l211" href="#l211">211</a><td>}</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../../../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../types.js"></script><script src="../../../dossier.js"></script>
package/docs/source/lib/atoms/json.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>json.js</title><link href="../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/atoms/json.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2012 WebDriver committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2012 Google Inc.<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>/**<tr><td><a name="l17" href="#l17">17</a><td> * @fileoverview Provides JSON utilities that uses native JSON parsing where<tr><td><a name="l18" href="#l18">18</a><td> * possible (a feature not currently offered by Closure).<tr><td><a name="l19" href="#l19">19</a><td> */<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;bot.json&#39;);<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>goog.require(&#39;bot.userAgent&#39;);<tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;goog.json&#39;);<tr><td><a name="l25" href="#l25">25</a><td>goog.require(&#39;goog.userAgent&#39;);<tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td><tr><td><a name="l28" href="#l28">28</a><td>/**<tr><td><a name="l29" href="#l29">29</a><td> * @define {boolean} NATIVE_JSON indicates whether the code should rely on the<tr><td><a name="l30" href="#l30">30</a><td> * native {@code JSON} functions, if available.<tr><td><a name="l31" href="#l31">31</a><td> *<tr><td><a name="l32" href="#l32">32</a><td> * &lt;p&gt;The JSON functions can be defined by external libraries like Prototype<tr><td><a name="l33" href="#l33">33</a><td> * and setting this flag to false forces the use of Closure&#39;s goog.json<tr><td><a name="l34" href="#l34">34</a><td> * implementation.<tr><td><a name="l35" href="#l35">35</a><td> *<tr><td><a name="l36" href="#l36">36</a><td> * &lt;p&gt;If your JavaScript can be loaded by a third_party site and you are wary<tr><td><a name="l37" href="#l37">37</a><td> * about relying on the native functions, specify<tr><td><a name="l38" href="#l38">38</a><td> * &quot;--define bot.json.NATIVE_JSON=false&quot; to the Closure compiler.<tr><td><a name="l39" href="#l39">39</a><td> */<tr><td><a name="l40" href="#l40">40</a><td>bot.json.NATIVE_JSON = true;<tr><td><a name="l41" href="#l41">41</a><td><tr><td><a name="l42" href="#l42">42</a><td><tr><td><a name="l43" href="#l43">43</a><td>/**<tr><td><a name="l44" href="#l44">44</a><td> * Whether the current browser supports the native JSON interface.<tr><td><a name="l45" href="#l45">45</a><td> * @const<tr><td><a name="l46" href="#l46">46</a><td> * @see http://caniuse.com/#search=JSON<tr><td><a name="l47" href="#l47">47</a><td> * @private {boolean}<tr><td><a name="l48" href="#l48">48</a><td> */<tr><td><a name="l49" href="#l49">49</a><td>bot.json.SUPPORTS_NATIVE_JSON_ =<tr><td><a name="l50" href="#l50">50</a><td> // List WebKit and Opera first since every supported version of these<tr><td><a name="l51" href="#l51">51</a><td> // browsers supports native JSON (and we can compile away large chunks of<tr><td><a name="l52" href="#l52">52</a><td> // code for individual fragments by setting the appropriate compiler flags).<tr><td><a name="l53" href="#l53">53</a><td> goog.userAgent.WEBKIT || goog.userAgent.OPERA ||<tr><td><a name="l54" href="#l54">54</a><td> (goog.userAgent.GECKO &amp;&amp; bot.userAgent.isEngineVersion(3.5)) ||<tr><td><a name="l55" href="#l55">55</a><td> (goog.userAgent.IE &amp;&amp; bot.userAgent.isEngineVersion(8));<tr><td><a name="l56" href="#l56">56</a><td><tr><td><a name="l57" href="#l57">57</a><td><tr><td><a name="l58" href="#l58">58</a><td>/**<tr><td><a name="l59" href="#l59">59</a><td> * Converts a JSON object to its string representation.<tr><td><a name="l60" href="#l60">60</a><td> * @param {*} jsonObj The input object.<tr><td><a name="l61" href="#l61">61</a><td> * @param {?(function(string, *): *)=} opt_replacer A replacer function called<tr><td><a name="l62" href="#l62">62</a><td> * for each (key, value) pair that determines how the value should be<tr><td><a name="l63" href="#l63">63</a><td> * serialized. By default, this just returns the value and allows default<tr><td><a name="l64" href="#l64">64</a><td> * serialization to kick in.<tr><td><a name="l65" href="#l65">65</a><td> * @return {string} A JSON string representation of the input object.<tr><td><a name="l66" href="#l66">66</a><td> */<tr><td><a name="l67" href="#l67">67</a><td>bot.json.stringify = bot.json.NATIVE_JSON &amp;&amp; bot.json.SUPPORTS_NATIVE_JSON_ ?<tr><td><a name="l68" href="#l68">68</a><td> JSON.stringify : goog.json.serialize;<tr><td><a name="l69" href="#l69">69</a><td><tr><td><a name="l70" href="#l70">70</a><td><tr><td><a name="l71" href="#l71">71</a><td>/**<tr><td><a name="l72" href="#l72">72</a><td> * Parses a JSON string and returns the result.<tr><td><a name="l73" href="#l73">73</a><td> * @param {string} jsonStr The string to parse.<tr><td><a name="l74" href="#l74">74</a><td> * @return {*} The JSON object.<tr><td><a name="l75" href="#l75">75</a><td> * @throws {Error} If the input string is an invalid JSON string.<tr><td><a name="l76" href="#l76">76</a><td> */<tr><td><a name="l77" href="#l77">77</a><td>bot.json.parse = bot.json.NATIVE_JSON &amp;&amp; bot.json.SUPPORTS_NATIVE_JSON_ ?<tr><td><a name="l78" href="#l78">78</a><td> JSON.parse : goog.json.parse;</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../types.js"></script><script src="../../../dossier.js"></script>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>json.js</title><link href="../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/atoms/json.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2012 WebDriver committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2012 Google Inc.<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>/**<tr><td><a name="l17" href="#l17">17</a><td> * @fileoverview Provides JSON utilities that uses native JSON parsing where<tr><td><a name="l18" href="#l18">18</a><td> * possible (a feature not currently offered by Closure).<tr><td><a name="l19" href="#l19">19</a><td> */<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;bot.json&#39;);<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>goog.require(&#39;bot.userAgent&#39;);<tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;goog.json&#39;);<tr><td><a name="l25" href="#l25">25</a><td>goog.require(&#39;goog.userAgent&#39;);<tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td><tr><td><a name="l28" href="#l28">28</a><td>/**<tr><td><a name="l29" href="#l29">29</a><td> * @define {boolean} NATIVE_JSON indicates whether the code should rely on the<tr><td><a name="l30" href="#l30">30</a><td> * native {@code JSON} functions, if available.<tr><td><a name="l31" href="#l31">31</a><td> *<tr><td><a name="l32" href="#l32">32</a><td> * &lt;p&gt;The JSON functions can be defined by external libraries like Prototype<tr><td><a name="l33" href="#l33">33</a><td> * and setting this flag to false forces the use of Closure&#39;s goog.json<tr><td><a name="l34" href="#l34">34</a><td> * implementation.<tr><td><a name="l35" href="#l35">35</a><td> *<tr><td><a name="l36" href="#l36">36</a><td> * &lt;p&gt;If your JavaScript can be loaded by a third_party site and you are wary<tr><td><a name="l37" href="#l37">37</a><td> * about relying on the native functions, specify<tr><td><a name="l38" href="#l38">38</a><td> * &quot;--define bot.json.NATIVE_JSON=false&quot; to the Closure compiler.<tr><td><a name="l39" href="#l39">39</a><td> */<tr><td><a name="l40" href="#l40">40</a><td>bot.json.NATIVE_JSON = true;<tr><td><a name="l41" href="#l41">41</a><td><tr><td><a name="l42" href="#l42">42</a><td><tr><td><a name="l43" href="#l43">43</a><td>/**<tr><td><a name="l44" href="#l44">44</a><td> * Whether the current browser supports the native JSON interface.<tr><td><a name="l45" href="#l45">45</a><td> * @const<tr><td><a name="l46" href="#l46">46</a><td> * @see http://caniuse.com/#search=JSON<tr><td><a name="l47" href="#l47">47</a><td> * @private {boolean}<tr><td><a name="l48" href="#l48">48</a><td> */<tr><td><a name="l49" href="#l49">49</a><td>bot.json.SUPPORTS_NATIVE_JSON_ =<tr><td><a name="l50" href="#l50">50</a><td> // List WebKit and Opera first since every supported version of these<tr><td><a name="l51" href="#l51">51</a><td> // browsers supports native JSON (and we can compile away large chunks of<tr><td><a name="l52" href="#l52">52</a><td> // code for individual fragments by setting the appropriate compiler flags).<tr><td><a name="l53" href="#l53">53</a><td> goog.userAgent.WEBKIT || goog.userAgent.OPERA ||<tr><td><a name="l54" href="#l54">54</a><td> (goog.userAgent.GECKO &amp;&amp; bot.userAgent.isEngineVersion(3.5)) ||<tr><td><a name="l55" href="#l55">55</a><td> (goog.userAgent.IE &amp;&amp; bot.userAgent.isEngineVersion(8));<tr><td><a name="l56" href="#l56">56</a><td><tr><td><a name="l57" href="#l57">57</a><td><tr><td><a name="l58" href="#l58">58</a><td>/**<tr><td><a name="l59" href="#l59">59</a><td> * Converts a JSON object to its string representation.<tr><td><a name="l60" href="#l60">60</a><td> * @param {*} jsonObj The input object.<tr><td><a name="l61" href="#l61">61</a><td> * @param {?(function(string, *): *)=} opt_replacer A replacer function called<tr><td><a name="l62" href="#l62">62</a><td> * for each (key, value) pair that determines how the value should be<tr><td><a name="l63" href="#l63">63</a><td> * serialized. By default, this just returns the value and allows default<tr><td><a name="l64" href="#l64">64</a><td> * serialization to kick in.<tr><td><a name="l65" href="#l65">65</a><td> * @return {string} A JSON string representation of the input object.<tr><td><a name="l66" href="#l66">66</a><td> */<tr><td><a name="l67" href="#l67">67</a><td>bot.json.stringify = bot.json.NATIVE_JSON &amp;&amp; bot.json.SUPPORTS_NATIVE_JSON_ ?<tr><td><a name="l68" href="#l68">68</a><td> JSON.stringify : goog.json.serialize;<tr><td><a name="l69" href="#l69">69</a><td><tr><td><a name="l70" href="#l70">70</a><td><tr><td><a name="l71" href="#l71">71</a><td>/**<tr><td><a name="l72" href="#l72">72</a><td> * Parses a JSON string and returns the result.<tr><td><a name="l73" href="#l73">73</a><td> * @param {string} jsonStr The string to parse.<tr><td><a name="l74" href="#l74">74</a><td> * @return {*} The JSON object.<tr><td><a name="l75" href="#l75">75</a><td> * @throws {Error} If the input string is an invalid JSON string.<tr><td><a name="l76" href="#l76">76</a><td> */<tr><td><a name="l77" href="#l77">77</a><td>bot.json.parse = bot.json.NATIVE_JSON &amp;&amp; bot.json.SUPPORTS_NATIVE_JSON_ ?<tr><td><a name="l78" href="#l78">78</a><td> JSON.parse : goog.json.parse;</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../../../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../types.js"></script><script src="../../../dossier.js"></script>
package/docs/source/lib/atoms/response.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>response.js</title><link href="../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/atoms/response.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 Software Freedom Conservancy. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Utilities for working with WebDriver response objects.<tr><td><a name="l17" href="#l17">17</a><td> * @see: http://code.google.com/p/selenium/wiki/JsonWireProtocol#Responses<tr><td><a name="l18" href="#l18">18</a><td> */<tr><td><a name="l19" href="#l19">19</a><td><tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;bot.response&#39;);<tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;bot.response.ResponseObject&#39;);<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>goog.require(&#39;bot.Error&#39;);<tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;bot.ErrorCode&#39;);<tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td>/**<tr><td><a name="l28" href="#l28">28</a><td> * Type definition for a response object, as defined by the JSON wire protocol.<tr><td><a name="l29" href="#l29">29</a><td> * @typedef {{status: bot.ErrorCode, value: (*|{message: string})}}<tr><td><a name="l30" href="#l30">30</a><td> * @see http://code.google.com/p/selenium/wiki/JsonWireProtocol#Responses<tr><td><a name="l31" href="#l31">31</a><td> */<tr><td><a name="l32" href="#l32">32</a><td>bot.response.ResponseObject;<tr><td><a name="l33" href="#l33">33</a><td><tr><td><a name="l34" href="#l34">34</a><td><tr><td><a name="l35" href="#l35">35</a><td>/**<tr><td><a name="l36" href="#l36">36</a><td> * @param {*} value The value to test.<tr><td><a name="l37" href="#l37">37</a><td> * @return {boolean} Whether the given value is a response object.<tr><td><a name="l38" href="#l38">38</a><td> */<tr><td><a name="l39" href="#l39">39</a><td>bot.response.isResponseObject = function(value) {<tr><td><a name="l40" href="#l40">40</a><td> return goog.isObject(value) &amp;&amp; goog.isNumber(value[&#39;status&#39;]);<tr><td><a name="l41" href="#l41">41</a><td>};<tr><td><a name="l42" href="#l42">42</a><td><tr><td><a name="l43" href="#l43">43</a><td><tr><td><a name="l44" href="#l44">44</a><td>/**<tr><td><a name="l45" href="#l45">45</a><td> * Creates a new success response object with the provided value.<tr><td><a name="l46" href="#l46">46</a><td> * @param {*} value The response value.<tr><td><a name="l47" href="#l47">47</a><td> * @return {!bot.response.ResponseObject} The new response object.<tr><td><a name="l48" href="#l48">48</a><td> */<tr><td><a name="l49" href="#l49">49</a><td>bot.response.createResponse = function(value) {<tr><td><a name="l50" href="#l50">50</a><td> if (bot.response.isResponseObject(value)) {<tr><td><a name="l51" href="#l51">51</a><td> return /** @type {!bot.response.ResponseObject} */ (value);<tr><td><a name="l52" href="#l52">52</a><td> }<tr><td><a name="l53" href="#l53">53</a><td> return {<tr><td><a name="l54" href="#l54">54</a><td> &#39;status&#39;: bot.ErrorCode.SUCCESS,<tr><td><a name="l55" href="#l55">55</a><td> &#39;value&#39;: value<tr><td><a name="l56" href="#l56">56</a><td> };<tr><td><a name="l57" href="#l57">57</a><td>};<tr><td><a name="l58" href="#l58">58</a><td><tr><td><a name="l59" href="#l59">59</a><td><tr><td><a name="l60" href="#l60">60</a><td>/**<tr><td><a name="l61" href="#l61">61</a><td> * Converts an error value into its JSON representation as defined by the<tr><td><a name="l62" href="#l62">62</a><td> * WebDriver wire protocol.<tr><td><a name="l63" href="#l63">63</a><td> * @param {(bot.Error|Error|*)} error The error value to convert.<tr><td><a name="l64" href="#l64">64</a><td> * @return {!bot.response.ResponseObject} The new response object.<tr><td><a name="l65" href="#l65">65</a><td> */<tr><td><a name="l66" href="#l66">66</a><td>bot.response.createErrorResponse = function(error) {<tr><td><a name="l67" href="#l67">67</a><td> if (bot.response.isResponseObject(error)) {<tr><td><a name="l68" href="#l68">68</a><td> return /** @type {!bot.response.ResponseObject} */ (error);<tr><td><a name="l69" href="#l69">69</a><td> }<tr><td><a name="l70" href="#l70">70</a><td><tr><td><a name="l71" href="#l71">71</a><td> var statusCode = error &amp;&amp; goog.isNumber(error.code) ? error.code :<tr><td><a name="l72" href="#l72">72</a><td> bot.ErrorCode.UNKNOWN_ERROR;<tr><td><a name="l73" href="#l73">73</a><td> return {<tr><td><a name="l74" href="#l74">74</a><td> &#39;status&#39;: /** @type {bot.ErrorCode} */ (statusCode),<tr><td><a name="l75" href="#l75">75</a><td> &#39;value&#39;: {<tr><td><a name="l76" href="#l76">76</a><td> &#39;message&#39;: (error &amp;&amp; error.message || error) + &#39;&#39;<tr><td><a name="l77" href="#l77">77</a><td> }<tr><td><a name="l78" href="#l78">78</a><td> };<tr><td><a name="l79" href="#l79">79</a><td>};<tr><td><a name="l80" href="#l80">80</a><td><tr><td><a name="l81" href="#l81">81</a><td><tr><td><a name="l82" href="#l82">82</a><td>/**<tr><td><a name="l83" href="#l83">83</a><td> * Checks that a response object does not specify an error as defined by the<tr><td><a name="l84" href="#l84">84</a><td> * WebDriver wire protocol. If the response object defines an error, it will<tr><td><a name="l85" href="#l85">85</a><td> * be thrown. Otherwise, the response will be returned as is.<tr><td><a name="l86" href="#l86">86</a><td> * @param {!bot.response.ResponseObject} responseObj The response object to<tr><td><a name="l87" href="#l87">87</a><td> * check.<tr><td><a name="l88" href="#l88">88</a><td> * @return {!bot.response.ResponseObject} The checked response object.<tr><td><a name="l89" href="#l89">89</a><td> * @throws {bot.Error} If the response describes an error.<tr><td><a name="l90" href="#l90">90</a><td> * @see http://code.google.com/p/selenium/wiki/JsonWireProtocol#Failed_Commands<tr><td><a name="l91" href="#l91">91</a><td> */<tr><td><a name="l92" href="#l92">92</a><td>bot.response.checkResponse = function(responseObj) {<tr><td><a name="l93" href="#l93">93</a><td> var status = responseObj[&#39;status&#39;];<tr><td><a name="l94" href="#l94">94</a><td> if (status == bot.ErrorCode.SUCCESS) {<tr><td><a name="l95" href="#l95">95</a><td> return responseObj;<tr><td><a name="l96" href="#l96">96</a><td> }<tr><td><a name="l97" href="#l97">97</a><td><tr><td><a name="l98" href="#l98">98</a><td> // If status is not defined, assume an unknown error.<tr><td><a name="l99" href="#l99">99</a><td> status = status || bot.ErrorCode.UNKNOWN_ERROR;<tr><td><a name="l100" href="#l100">100</a><td><tr><td><a name="l101" href="#l101">101</a><td> var value = responseObj[&#39;value&#39;];<tr><td><a name="l102" href="#l102">102</a><td> if (!value || !goog.isObject(value)) {<tr><td><a name="l103" href="#l103">103</a><td> throw new bot.Error(status, value + &#39;&#39;);<tr><td><a name="l104" href="#l104">104</a><td> }<tr><td><a name="l105" href="#l105">105</a><td><tr><td><a name="l106" href="#l106">106</a><td> throw new bot.Error(status, value[&#39;message&#39;] + &#39;&#39;);<tr><td><a name="l107" href="#l107">107</a><td>};</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../types.js"></script><script src="../../../dossier.js"></script>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>response.js</title><link href="../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/atoms/response.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 Software Freedom Conservancy. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Utilities for working with WebDriver response objects.<tr><td><a name="l17" href="#l17">17</a><td> * @see: http://code.google.com/p/selenium/wiki/JsonWireProtocol#Responses<tr><td><a name="l18" href="#l18">18</a><td> */<tr><td><a name="l19" href="#l19">19</a><td><tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;bot.response&#39;);<tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;bot.response.ResponseObject&#39;);<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>goog.require(&#39;bot.Error&#39;);<tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;bot.ErrorCode&#39;);<tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td>/**<tr><td><a name="l28" href="#l28">28</a><td> * Type definition for a response object, as defined by the JSON wire protocol.<tr><td><a name="l29" href="#l29">29</a><td> * @typedef {{status: bot.ErrorCode, value: (*|{message: string})}}<tr><td><a name="l30" href="#l30">30</a><td> * @see http://code.google.com/p/selenium/wiki/JsonWireProtocol#Responses<tr><td><a name="l31" href="#l31">31</a><td> */<tr><td><a name="l32" href="#l32">32</a><td>bot.response.ResponseObject;<tr><td><a name="l33" href="#l33">33</a><td><tr><td><a name="l34" href="#l34">34</a><td><tr><td><a name="l35" href="#l35">35</a><td>/**<tr><td><a name="l36" href="#l36">36</a><td> * @param {*} value The value to test.<tr><td><a name="l37" href="#l37">37</a><td> * @return {boolean} Whether the given value is a response object.<tr><td><a name="l38" href="#l38">38</a><td> */<tr><td><a name="l39" href="#l39">39</a><td>bot.response.isResponseObject = function(value) {<tr><td><a name="l40" href="#l40">40</a><td> return goog.isObject(value) &amp;&amp; goog.isNumber(value[&#39;status&#39;]);<tr><td><a name="l41" href="#l41">41</a><td>};<tr><td><a name="l42" href="#l42">42</a><td><tr><td><a name="l43" href="#l43">43</a><td><tr><td><a name="l44" href="#l44">44</a><td>/**<tr><td><a name="l45" href="#l45">45</a><td> * Creates a new success response object with the provided value.<tr><td><a name="l46" href="#l46">46</a><td> * @param {*} value The response value.<tr><td><a name="l47" href="#l47">47</a><td> * @return {!bot.response.ResponseObject} The new response object.<tr><td><a name="l48" href="#l48">48</a><td> */<tr><td><a name="l49" href="#l49">49</a><td>bot.response.createResponse = function(value) {<tr><td><a name="l50" href="#l50">50</a><td> if (bot.response.isResponseObject(value)) {<tr><td><a name="l51" href="#l51">51</a><td> return /** @type {!bot.response.ResponseObject} */ (value);<tr><td><a name="l52" href="#l52">52</a><td> }<tr><td><a name="l53" href="#l53">53</a><td> return {<tr><td><a name="l54" href="#l54">54</a><td> &#39;status&#39;: bot.ErrorCode.SUCCESS,<tr><td><a name="l55" href="#l55">55</a><td> &#39;value&#39;: value<tr><td><a name="l56" href="#l56">56</a><td> };<tr><td><a name="l57" href="#l57">57</a><td>};<tr><td><a name="l58" href="#l58">58</a><td><tr><td><a name="l59" href="#l59">59</a><td><tr><td><a name="l60" href="#l60">60</a><td>/**<tr><td><a name="l61" href="#l61">61</a><td> * Converts an error value into its JSON representation as defined by the<tr><td><a name="l62" href="#l62">62</a><td> * WebDriver wire protocol.<tr><td><a name="l63" href="#l63">63</a><td> * @param {(bot.Error|Error|*)} error The error value to convert.<tr><td><a name="l64" href="#l64">64</a><td> * @return {!bot.response.ResponseObject} The new response object.<tr><td><a name="l65" href="#l65">65</a><td> */<tr><td><a name="l66" href="#l66">66</a><td>bot.response.createErrorResponse = function(error) {<tr><td><a name="l67" href="#l67">67</a><td> if (bot.response.isResponseObject(error)) {<tr><td><a name="l68" href="#l68">68</a><td> return /** @type {!bot.response.ResponseObject} */ (error);<tr><td><a name="l69" href="#l69">69</a><td> }<tr><td><a name="l70" href="#l70">70</a><td><tr><td><a name="l71" href="#l71">71</a><td> var statusCode = error &amp;&amp; goog.isNumber(error.code) ? error.code :<tr><td><a name="l72" href="#l72">72</a><td> bot.ErrorCode.UNKNOWN_ERROR;<tr><td><a name="l73" href="#l73">73</a><td> return {<tr><td><a name="l74" href="#l74">74</a><td> &#39;status&#39;: /** @type {bot.ErrorCode} */ (statusCode),<tr><td><a name="l75" href="#l75">75</a><td> &#39;value&#39;: {<tr><td><a name="l76" href="#l76">76</a><td> &#39;message&#39;: (error &amp;&amp; error.message || error) + &#39;&#39;<tr><td><a name="l77" href="#l77">77</a><td> }<tr><td><a name="l78" href="#l78">78</a><td> };<tr><td><a name="l79" href="#l79">79</a><td>};<tr><td><a name="l80" href="#l80">80</a><td><tr><td><a name="l81" href="#l81">81</a><td><tr><td><a name="l82" href="#l82">82</a><td>/**<tr><td><a name="l83" href="#l83">83</a><td> * Checks that a response object does not specify an error as defined by the<tr><td><a name="l84" href="#l84">84</a><td> * WebDriver wire protocol. If the response object defines an error, it will<tr><td><a name="l85" href="#l85">85</a><td> * be thrown. Otherwise, the response will be returned as is.<tr><td><a name="l86" href="#l86">86</a><td> * @param {!bot.response.ResponseObject} responseObj The response object to<tr><td><a name="l87" href="#l87">87</a><td> * check.<tr><td><a name="l88" href="#l88">88</a><td> * @return {!bot.response.ResponseObject} The checked response object.<tr><td><a name="l89" href="#l89">89</a><td> * @throws {bot.Error} If the response describes an error.<tr><td><a name="l90" href="#l90">90</a><td> * @see http://code.google.com/p/selenium/wiki/JsonWireProtocol#Failed_Commands<tr><td><a name="l91" href="#l91">91</a><td> */<tr><td><a name="l92" href="#l92">92</a><td>bot.response.checkResponse = function(responseObj) {<tr><td><a name="l93" href="#l93">93</a><td> var status = responseObj[&#39;status&#39;];<tr><td><a name="l94" href="#l94">94</a><td> if (status == bot.ErrorCode.SUCCESS) {<tr><td><a name="l95" href="#l95">95</a><td> return responseObj;<tr><td><a name="l96" href="#l96">96</a><td> }<tr><td><a name="l97" href="#l97">97</a><td><tr><td><a name="l98" href="#l98">98</a><td> // If status is not defined, assume an unknown error.<tr><td><a name="l99" href="#l99">99</a><td> status = status || bot.ErrorCode.UNKNOWN_ERROR;<tr><td><a name="l100" href="#l100">100</a><td><tr><td><a name="l101" href="#l101">101</a><td> var value = responseObj[&#39;value&#39;];<tr><td><a name="l102" href="#l102">102</a><td> if (!value || !goog.isObject(value)) {<tr><td><a name="l103" href="#l103">103</a><td> throw new bot.Error(status, value + &#39;&#39;);<tr><td><a name="l104" href="#l104">104</a><td> }<tr><td><a name="l105" href="#l105">105</a><td><tr><td><a name="l106" href="#l106">106</a><td> throw new bot.Error(status, value[&#39;message&#39;] + &#39;&#39;);<tr><td><a name="l107" href="#l107">107</a><td>};</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../../../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../types.js"></script><script src="../../../dossier.js"></script>
package/docs/source/lib/atoms/userAgent.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>userAgent.js</title><link href="../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/atoms/userAgent.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 WebDriver committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2011 Google Inc.<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>/**<tr><td><a name="l17" href="#l17">17</a><td> * @fileoverview Similar to goog.userAgent.isVersion, but with support for<tr><td><a name="l18" href="#l18">18</a><td> * getting the version information when running in a firefox extension.<tr><td><a name="l19" href="#l19">19</a><td> */<tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;bot.userAgent&#39;);<tr><td><a name="l21" href="#l21">21</a><td><tr><td><a name="l22" href="#l22">22</a><td>goog.require(&#39;goog.string&#39;);<tr><td><a name="l23" href="#l23">23</a><td>goog.require(&#39;goog.userAgent&#39;);<tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;goog.userAgent.product&#39;);<tr><td><a name="l25" href="#l25">25</a><td>goog.require(&#39;goog.userAgent.product.isVersion&#39;);<tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td><tr><td><a name="l28" href="#l28">28</a><td>/**<tr><td><a name="l29" href="#l29">29</a><td> * Whether the rendering engine version of the current browser is equal to or<tr><td><a name="l30" href="#l30">30</a><td> * greater than the given version. This implementation differs from<tr><td><a name="l31" href="#l31">31</a><td> * goog.userAgent.isVersion in the following ways:<tr><td><a name="l32" href="#l32">32</a><td> * &lt;ol&gt;<tr><td><a name="l33" href="#l33">33</a><td> * &lt;li&gt;in a Firefox extension, tests the engine version through the XUL version<tr><td><a name="l34" href="#l34">34</a><td> * comparator service, because no window.navigator object is available<tr><td><a name="l35" href="#l35">35</a><td> * &lt;li&gt;in IE, compares the given version to the current documentMode<tr><td><a name="l36" href="#l36">36</a><td> * &lt;/ol&gt;<tr><td><a name="l37" href="#l37">37</a><td> *<tr><td><a name="l38" href="#l38">38</a><td> * @param {string|number} version The version number to check.<tr><td><a name="l39" href="#l39">39</a><td> * @return {boolean} Whether the browser engine version is the same or higher<tr><td><a name="l40" href="#l40">40</a><td> * than the given version.<tr><td><a name="l41" href="#l41">41</a><td> */<tr><td><a name="l42" href="#l42">42</a><td>bot.userAgent.isEngineVersion = function(version) {<tr><td><a name="l43" href="#l43">43</a><td> if (bot.userAgent.FIREFOX_EXTENSION) {<tr><td><a name="l44" href="#l44">44</a><td> return bot.userAgent.FIREFOX_EXTENSION_IS_ENGINE_VERSION_(version);<tr><td><a name="l45" href="#l45">45</a><td> } else if (goog.userAgent.IE) {<tr><td><a name="l46" href="#l46">46</a><td> return goog.string.compareVersions(<tr><td><a name="l47" href="#l47">47</a><td> /** @type {number} */ (goog.userAgent.DOCUMENT_MODE), version) &gt;= 0;<tr><td><a name="l48" href="#l48">48</a><td> } else {<tr><td><a name="l49" href="#l49">49</a><td> return goog.userAgent.isVersionOrHigher(version);<tr><td><a name="l50" href="#l50">50</a><td> }<tr><td><a name="l51" href="#l51">51</a><td>};<tr><td><a name="l52" href="#l52">52</a><td><tr><td><a name="l53" href="#l53">53</a><td><tr><td><a name="l54" href="#l54">54</a><td>/**<tr><td><a name="l55" href="#l55">55</a><td> * Whether the product version of the current browser is equal to or greater<tr><td><a name="l56" href="#l56">56</a><td> * than the given version. This implementation differs from<tr><td><a name="l57" href="#l57">57</a><td> * goog.userAgent.product.isVersion in the following ways:<tr><td><a name="l58" href="#l58">58</a><td> * &lt;ol&gt;<tr><td><a name="l59" href="#l59">59</a><td> * &lt;li&gt;in a Firefox extension, tests the product version through the XUL version<tr><td><a name="l60" href="#l60">60</a><td> * comparator service, because no window.navigator object is available<tr><td><a name="l61" href="#l61">61</a><td> * &lt;li&gt;on Android, always compares to the version to the OS version<tr><td><a name="l62" href="#l62">62</a><td> * &lt;/ol&gt;<tr><td><a name="l63" href="#l63">63</a><td> *<tr><td><a name="l64" href="#l64">64</a><td> * @param {string|number} version The version number to check.<tr><td><a name="l65" href="#l65">65</a><td> * @return {boolean} Whether the browser product version is the same or higher<tr><td><a name="l66" href="#l66">66</a><td> * than the given version.<tr><td><a name="l67" href="#l67">67</a><td> */<tr><td><a name="l68" href="#l68">68</a><td>bot.userAgent.isProductVersion = function(version) {<tr><td><a name="l69" href="#l69">69</a><td> if (bot.userAgent.FIREFOX_EXTENSION) {<tr><td><a name="l70" href="#l70">70</a><td> return bot.userAgent.FIREFOX_EXTENSION_IS_PRODUCT_VERSION_(version);<tr><td><a name="l71" href="#l71">71</a><td> } else if (goog.userAgent.product.ANDROID) {<tr><td><a name="l72" href="#l72">72</a><td> return goog.string.compareVersions(<tr><td><a name="l73" href="#l73">73</a><td> bot.userAgent.ANDROID_VERSION_, version) &gt;= 0;<tr><td><a name="l74" href="#l74">74</a><td> } else {<tr><td><a name="l75" href="#l75">75</a><td> return goog.userAgent.product.isVersion(version);<tr><td><a name="l76" href="#l76">76</a><td> }<tr><td><a name="l77" href="#l77">77</a><td>};<tr><td><a name="l78" href="#l78">78</a><td><tr><td><a name="l79" href="#l79">79</a><td><tr><td><a name="l80" href="#l80">80</a><td>/**<tr><td><a name="l81" href="#l81">81</a><td> * When we are in a Firefox extension, this is a function that accepts a version<tr><td><a name="l82" href="#l82">82</a><td> * and returns whether the version of Gecko we are on is the same or higher<tr><td><a name="l83" href="#l83">83</a><td> * than the given version. When we are not in a Firefox extension, this is null.<tr><td><a name="l84" href="#l84">84</a><td> * @private {(undefined|function((string|number)): boolean)}<tr><td><a name="l85" href="#l85">85</a><td> */<tr><td><a name="l86" href="#l86">86</a><td>bot.userAgent.FIREFOX_EXTENSION_IS_ENGINE_VERSION_;<tr><td><a name="l87" href="#l87">87</a><td><tr><td><a name="l88" href="#l88">88</a><td><tr><td><a name="l89" href="#l89">89</a><td>/**<tr><td><a name="l90" href="#l90">90</a><td> * When we are in a Firefox extension, this is a function that accepts a version<tr><td><a name="l91" href="#l91">91</a><td> * and returns whether the version of Firefox we are on is the same or higher<tr><td><a name="l92" href="#l92">92</a><td> * than the given version. When we are not in a Firefox extension, this is null.<tr><td><a name="l93" href="#l93">93</a><td> * @private {(undefined|function((string|number)): boolean)}<tr><td><a name="l94" href="#l94">94</a><td> */<tr><td><a name="l95" href="#l95">95</a><td>bot.userAgent.FIREFOX_EXTENSION_IS_PRODUCT_VERSION_;<tr><td><a name="l96" href="#l96">96</a><td><tr><td><a name="l97" href="#l97">97</a><td><tr><td><a name="l98" href="#l98">98</a><td>/**<tr><td><a name="l99" href="#l99">99</a><td> * Whether we are in a Firefox extension.<tr><td><a name="l100" href="#l100">100</a><td> *<tr><td><a name="l101" href="#l101">101</a><td> * @const<tr><td><a name="l102" href="#l102">102</a><td> * @type {boolean}<tr><td><a name="l103" href="#l103">103</a><td> */<tr><td><a name="l104" href="#l104">104</a><td>bot.userAgent.FIREFOX_EXTENSION = (function() {<tr><td><a name="l105" href="#l105">105</a><td> // False if this browser is not a Gecko browser.<tr><td><a name="l106" href="#l106">106</a><td> if (!goog.userAgent.GECKO) {<tr><td><a name="l107" href="#l107">107</a><td> return false;<tr><td><a name="l108" href="#l108">108</a><td> }<tr><td><a name="l109" href="#l109">109</a><td><tr><td><a name="l110" href="#l110">110</a><td> // False if this code isn&#39;t running in an extension.<tr><td><a name="l111" href="#l111">111</a><td> var Components = goog.global.Components;<tr><td><a name="l112" href="#l112">112</a><td> if (!Components) {<tr><td><a name="l113" href="#l113">113</a><td> return false;<tr><td><a name="l114" href="#l114">114</a><td> }<tr><td><a name="l115" href="#l115">115</a><td> try {<tr><td><a name="l116" href="#l116">116</a><td> if (!Components[&#39;classes&#39;]) {<tr><td><a name="l117" href="#l117">117</a><td> return false;<tr><td><a name="l118" href="#l118">118</a><td> }<tr><td><a name="l119" href="#l119">119</a><td> } catch (e) {<tr><td><a name="l120" href="#l120">120</a><td> return false;<tr><td><a name="l121" href="#l121">121</a><td> }<tr><td><a name="l122" href="#l122">122</a><td><tr><td><a name="l123" href="#l123">123</a><td> // Populate the version checker functions.<tr><td><a name="l124" href="#l124">124</a><td> var cc = Components[&#39;classes&#39;];<tr><td><a name="l125" href="#l125">125</a><td> var ci = Components[&#39;interfaces&#39;];<tr><td><a name="l126" href="#l126">126</a><td> var versionComparator = cc[&#39;@mozilla.org/xpcom/version-comparator;1&#39;][<tr><td><a name="l127" href="#l127">127</a><td> &#39;getService&#39;](ci[&#39;nsIVersionComparator&#39;]);<tr><td><a name="l128" href="#l128">128</a><td> var appInfo = cc[&#39;@mozilla.org/xre/app-info;1&#39;][&#39;getService&#39;](<tr><td><a name="l129" href="#l129">129</a><td> ci[&#39;nsIXULAppInfo&#39;]);<tr><td><a name="l130" href="#l130">130</a><td> var geckoVersion = appInfo[&#39;platformVersion&#39;];<tr><td><a name="l131" href="#l131">131</a><td> var firefoxVersion = appInfo[&#39;version&#39;];<tr><td><a name="l132" href="#l132">132</a><td><tr><td><a name="l133" href="#l133">133</a><td> bot.userAgent.FIREFOX_EXTENSION_IS_ENGINE_VERSION_ = function(version) {<tr><td><a name="l134" href="#l134">134</a><td> return versionComparator.compare(geckoVersion, &#39;&#39; + version) &gt;= 0;<tr><td><a name="l135" href="#l135">135</a><td> };<tr><td><a name="l136" href="#l136">136</a><td> bot.userAgent.FIREFOX_EXTENSION_IS_PRODUCT_VERSION_ = function(version) {<tr><td><a name="l137" href="#l137">137</a><td> return versionComparator.compare(firefoxVersion, &#39;&#39; + version) &gt;= 0;<tr><td><a name="l138" href="#l138">138</a><td> };<tr><td><a name="l139" href="#l139">139</a><td><tr><td><a name="l140" href="#l140">140</a><td> return true;<tr><td><a name="l141" href="#l141">141</a><td>})();<tr><td><a name="l142" href="#l142">142</a><td><tr><td><a name="l143" href="#l143">143</a><td><tr><td><a name="l144" href="#l144">144</a><td>/**<tr><td><a name="l145" href="#l145">145</a><td> * Whether we are on IOS.<tr><td><a name="l146" href="#l146">146</a><td> *<tr><td><a name="l147" href="#l147">147</a><td> * @const<tr><td><a name="l148" href="#l148">148</a><td> * @type {boolean}<tr><td><a name="l149" href="#l149">149</a><td> */<tr><td><a name="l150" href="#l150">150</a><td>bot.userAgent.IOS = goog.userAgent.product.IPAD ||<tr><td><a name="l151" href="#l151">151</a><td> goog.userAgent.product.IPHONE;<tr><td><a name="l152" href="#l152">152</a><td><tr><td><a name="l153" href="#l153">153</a><td><tr><td><a name="l154" href="#l154">154</a><td>/**<tr><td><a name="l155" href="#l155">155</a><td> * Whether we are on a mobile browser.<tr><td><a name="l156" href="#l156">156</a><td> *<tr><td><a name="l157" href="#l157">157</a><td> * @const<tr><td><a name="l158" href="#l158">158</a><td> * @type {boolean}<tr><td><a name="l159" href="#l159">159</a><td> */<tr><td><a name="l160" href="#l160">160</a><td>bot.userAgent.MOBILE = bot.userAgent.IOS || goog.userAgent.product.ANDROID;<tr><td><a name="l161" href="#l161">161</a><td><tr><td><a name="l162" href="#l162">162</a><td><tr><td><a name="l163" href="#l163">163</a><td>/**<tr><td><a name="l164" href="#l164">164</a><td> * Android Operating System Version.<tr><td><a name="l165" href="#l165">165</a><td> * @private {string}<tr><td><a name="l166" href="#l166">166</a><td> * @const<tr><td><a name="l167" href="#l167">167</a><td> */<tr><td><a name="l168" href="#l168">168</a><td>bot.userAgent.ANDROID_VERSION_ = (function() {<tr><td><a name="l169" href="#l169">169</a><td> if (goog.userAgent.product.ANDROID) {<tr><td><a name="l170" href="#l170">170</a><td> var userAgentString = goog.userAgent.getUserAgentString();<tr><td><a name="l171" href="#l171">171</a><td> var match = /Android\s+([0-9\.]+)/.exec(userAgentString);<tr><td><a name="l172" href="#l172">172</a><td> return match ? match[1] : &#39;0&#39;;<tr><td><a name="l173" href="#l173">173</a><td> } else {<tr><td><a name="l174" href="#l174">174</a><td> return &#39;0&#39;;<tr><td><a name="l175" href="#l175">175</a><td> }<tr><td><a name="l176" href="#l176">176</a><td>})();<tr><td><a name="l177" href="#l177">177</a><td><tr><td><a name="l178" href="#l178">178</a><td><tr><td><a name="l179" href="#l179">179</a><td>/**<tr><td><a name="l180" href="#l180">180</a><td> * Whether the current document is IE in a documentMode older than 8.<tr><td><a name="l181" href="#l181">181</a><td> * @type {boolean}<tr><td><a name="l182" href="#l182">182</a><td> * @const<tr><td><a name="l183" href="#l183">183</a><td> */<tr><td><a name="l184" href="#l184">184</a><td>bot.userAgent.IE_DOC_PRE8 = goog.userAgent.IE &amp;&amp;<tr><td><a name="l185" href="#l185">185</a><td> !goog.userAgent.isDocumentModeOrHigher(8);<tr><td><a name="l186" href="#l186">186</a><td><tr><td><a name="l187" href="#l187">187</a><td><tr><td><a name="l188" href="#l188">188</a><td>/**<tr><td><a name="l189" href="#l189">189</a><td> * Whether the current document is IE in IE9 (or newer) standards mode.<tr><td><a name="l190" href="#l190">190</a><td> * @type {boolean}<tr><td><a name="l191" href="#l191">191</a><td> * @const<tr><td><a name="l192" href="#l192">192</a><td> */<tr><td><a name="l193" href="#l193">193</a><td>bot.userAgent.IE_DOC_9 = goog.userAgent.isDocumentModeOrHigher(9);<tr><td><a name="l194" href="#l194">194</a><td><tr><td><a name="l195" href="#l195">195</a><td><tr><td><a name="l196" href="#l196">196</a><td>/**<tr><td><a name="l197" href="#l197">197</a><td> * Whether the current document is IE in a documentMode older than 9.<tr><td><a name="l198" href="#l198">198</a><td> * @type {boolean}<tr><td><a name="l199" href="#l199">199</a><td> * @const<tr><td><a name="l200" href="#l200">200</a><td> */<tr><td><a name="l201" href="#l201">201</a><td>bot.userAgent.IE_DOC_PRE9 = goog.userAgent.IE &amp;&amp;<tr><td><a name="l202" href="#l202">202</a><td> !goog.userAgent.isDocumentModeOrHigher(9);<tr><td><a name="l203" href="#l203">203</a><td><tr><td><a name="l204" href="#l204">204</a><td><tr><td><a name="l205" href="#l205">205</a><td>/**<tr><td><a name="l206" href="#l206">206</a><td> * Whether the current document is IE in IE10 (or newer) standards mode.<tr><td><a name="l207" href="#l207">207</a><td> * @type {boolean}<tr><td><a name="l208" href="#l208">208</a><td> * @const<tr><td><a name="l209" href="#l209">209</a><td> */<tr><td><a name="l210" href="#l210">210</a><td>bot.userAgent.IE_DOC_10 = goog.userAgent.isDocumentModeOrHigher(10);<tr><td><a name="l211" href="#l211">211</a><td><tr><td><a name="l212" href="#l212">212</a><td><tr><td><a name="l213" href="#l213">213</a><td>/**<tr><td><a name="l214" href="#l214">214</a><td> * Whether the current document is IE in a documentMode older than 10.<tr><td><a name="l215" href="#l215">215</a><td> * @type {boolean}<tr><td><a name="l216" href="#l216">216</a><td> * @const<tr><td><a name="l217" href="#l217">217</a><td> */<tr><td><a name="l218" href="#l218">218</a><td>bot.userAgent.IE_DOC_PRE10 = goog.userAgent.IE &amp;&amp;<tr><td><a name="l219" href="#l219">219</a><td> !goog.userAgent.isDocumentModeOrHigher(10);<tr><td><a name="l220" href="#l220">220</a><td><tr><td><a name="l221" href="#l221">221</a><td><tr><td><a name="l222" href="#l222">222</a><td>/**<tr><td><a name="l223" href="#l223">223</a><td> * Whether the current browser is Android pre-gingerbread.<tr><td><a name="l224" href="#l224">224</a><td> * @type {boolean}<tr><td><a name="l225" href="#l225">225</a><td> * @const<tr><td><a name="l226" href="#l226">226</a><td> */<tr><td><a name="l227" href="#l227">227</a><td>bot.userAgent.ANDROID_PRE_GINGERBREAD = goog.userAgent.product.ANDROID &amp;&amp;<tr><td><a name="l228" href="#l228">228</a><td> !bot.userAgent.isProductVersion(2.3);<tr><td><a name="l229" href="#l229">229</a><td><tr><td><a name="l230" href="#l230">230</a><td><tr><td><a name="l231" href="#l231">231</a><td>/**<tr><td><a name="l232" href="#l232">232</a><td> * Whether the current browser is Android pre-icecreamsandwich<tr><td><a name="l233" href="#l233">233</a><td> * @type {boolean}<tr><td><a name="l234" href="#l234">234</a><td> * @const<tr><td><a name="l235" href="#l235">235</a><td> */<tr><td><a name="l236" href="#l236">236</a><td>bot.userAgent.ANDROID_PRE_ICECREAMSANDWICH = goog.userAgent.product.ANDROID &amp;&amp;<tr><td><a name="l237" href="#l237">237</a><td> !bot.userAgent.isProductVersion(4);<tr><td><a name="l238" href="#l238">238</a><td><tr><td><a name="l239" href="#l239">239</a><td><tr><td><a name="l240" href="#l240">240</a><td>/**<tr><td><a name="l241" href="#l241">241</a><td> * Whether the current browser is Safari 6.<tr><td><a name="l242" href="#l242">242</a><td> * @type {boolean}<tr><td><a name="l243" href="#l243">243</a><td> * @const<tr><td><a name="l244" href="#l244">244</a><td> */<tr><td><a name="l245" href="#l245">245</a><td>bot.userAgent.SAFARI_6 = goog.userAgent.product.SAFARI &amp;&amp;<tr><td><a name="l246" href="#l246">246</a><td> bot.userAgent.isProductVersion(6);<tr><td><a name="l247" href="#l247">247</a><td><tr><td><a name="l248" href="#l248">248</a><td><tr><td><a name="l249" href="#l249">249</a><td>/**<tr><td><a name="l250" href="#l250">250</a><td> * Whether the current browser is Windows Phone.<tr><td><a name="l251" href="#l251">251</a><td> * @type {boolean}<tr><td><a name="l252" href="#l252">252</a><td> * @const<tr><td><a name="l253" href="#l253">253</a><td> */<tr><td><a name="l254" href="#l254">254</a><td>bot.userAgent.WINDOWS_PHONE = goog.userAgent.IE &amp;&amp;<tr><td><a name="l255" href="#l255">255</a><td> goog.userAgent.getUserAgentString().indexOf(&#39;IEMobile&#39;) != -1;</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../types.js"></script><script src="../../../dossier.js"></script>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>userAgent.js</title><link href="../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/atoms/userAgent.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 WebDriver committers<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2011 Google Inc.<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>/**<tr><td><a name="l17" href="#l17">17</a><td> * @fileoverview Similar to goog.userAgent.isVersion, but with support for<tr><td><a name="l18" href="#l18">18</a><td> * getting the version information when running in a firefox extension.<tr><td><a name="l19" href="#l19">19</a><td> */<tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;bot.userAgent&#39;);<tr><td><a name="l21" href="#l21">21</a><td><tr><td><a name="l22" href="#l22">22</a><td>goog.require(&#39;goog.string&#39;);<tr><td><a name="l23" href="#l23">23</a><td>goog.require(&#39;goog.userAgent&#39;);<tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;goog.userAgent.product&#39;);<tr><td><a name="l25" href="#l25">25</a><td>goog.require(&#39;goog.userAgent.product.isVersion&#39;);<tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td><tr><td><a name="l28" href="#l28">28</a><td>/**<tr><td><a name="l29" href="#l29">29</a><td> * Whether the rendering engine version of the current browser is equal to or<tr><td><a name="l30" href="#l30">30</a><td> * greater than the given version. This implementation differs from<tr><td><a name="l31" href="#l31">31</a><td> * goog.userAgent.isVersion in the following ways:<tr><td><a name="l32" href="#l32">32</a><td> * &lt;ol&gt;<tr><td><a name="l33" href="#l33">33</a><td> * &lt;li&gt;in a Firefox extension, tests the engine version through the XUL version<tr><td><a name="l34" href="#l34">34</a><td> * comparator service, because no window.navigator object is available<tr><td><a name="l35" href="#l35">35</a><td> * &lt;li&gt;in IE, compares the given version to the current documentMode<tr><td><a name="l36" href="#l36">36</a><td> * &lt;/ol&gt;<tr><td><a name="l37" href="#l37">37</a><td> *<tr><td><a name="l38" href="#l38">38</a><td> * @param {string|number} version The version number to check.<tr><td><a name="l39" href="#l39">39</a><td> * @return {boolean} Whether the browser engine version is the same or higher<tr><td><a name="l40" href="#l40">40</a><td> * than the given version.<tr><td><a name="l41" href="#l41">41</a><td> */<tr><td><a name="l42" href="#l42">42</a><td>bot.userAgent.isEngineVersion = function(version) {<tr><td><a name="l43" href="#l43">43</a><td> if (bot.userAgent.FIREFOX_EXTENSION) {<tr><td><a name="l44" href="#l44">44</a><td> return bot.userAgent.FIREFOX_EXTENSION_IS_ENGINE_VERSION_(version);<tr><td><a name="l45" href="#l45">45</a><td> } else if (goog.userAgent.IE) {<tr><td><a name="l46" href="#l46">46</a><td> return goog.string.compareVersions(<tr><td><a name="l47" href="#l47">47</a><td> /** @type {number} */ (goog.userAgent.DOCUMENT_MODE), version) &gt;= 0;<tr><td><a name="l48" href="#l48">48</a><td> } else {<tr><td><a name="l49" href="#l49">49</a><td> return goog.userAgent.isVersionOrHigher(version);<tr><td><a name="l50" href="#l50">50</a><td> }<tr><td><a name="l51" href="#l51">51</a><td>};<tr><td><a name="l52" href="#l52">52</a><td><tr><td><a name="l53" href="#l53">53</a><td><tr><td><a name="l54" href="#l54">54</a><td>/**<tr><td><a name="l55" href="#l55">55</a><td> * Whether the product version of the current browser is equal to or greater<tr><td><a name="l56" href="#l56">56</a><td> * than the given version. This implementation differs from<tr><td><a name="l57" href="#l57">57</a><td> * goog.userAgent.product.isVersion in the following ways:<tr><td><a name="l58" href="#l58">58</a><td> * &lt;ol&gt;<tr><td><a name="l59" href="#l59">59</a><td> * &lt;li&gt;in a Firefox extension, tests the product version through the XUL version<tr><td><a name="l60" href="#l60">60</a><td> * comparator service, because no window.navigator object is available<tr><td><a name="l61" href="#l61">61</a><td> * &lt;li&gt;on Android, always compares to the version to the OS version<tr><td><a name="l62" href="#l62">62</a><td> * &lt;/ol&gt;<tr><td><a name="l63" href="#l63">63</a><td> *<tr><td><a name="l64" href="#l64">64</a><td> * @param {string|number} version The version number to check.<tr><td><a name="l65" href="#l65">65</a><td> * @return {boolean} Whether the browser product version is the same or higher<tr><td><a name="l66" href="#l66">66</a><td> * than the given version.<tr><td><a name="l67" href="#l67">67</a><td> */<tr><td><a name="l68" href="#l68">68</a><td>bot.userAgent.isProductVersion = function(version) {<tr><td><a name="l69" href="#l69">69</a><td> if (bot.userAgent.FIREFOX_EXTENSION) {<tr><td><a name="l70" href="#l70">70</a><td> return bot.userAgent.FIREFOX_EXTENSION_IS_PRODUCT_VERSION_(version);<tr><td><a name="l71" href="#l71">71</a><td> } else if (goog.userAgent.product.ANDROID) {<tr><td><a name="l72" href="#l72">72</a><td> return goog.string.compareVersions(<tr><td><a name="l73" href="#l73">73</a><td> bot.userAgent.ANDROID_VERSION_, version) &gt;= 0;<tr><td><a name="l74" href="#l74">74</a><td> } else {<tr><td><a name="l75" href="#l75">75</a><td> return goog.userAgent.product.isVersion(version);<tr><td><a name="l76" href="#l76">76</a><td> }<tr><td><a name="l77" href="#l77">77</a><td>};<tr><td><a name="l78" href="#l78">78</a><td><tr><td><a name="l79" href="#l79">79</a><td><tr><td><a name="l80" href="#l80">80</a><td>/**<tr><td><a name="l81" href="#l81">81</a><td> * When we are in a Firefox extension, this is a function that accepts a version<tr><td><a name="l82" href="#l82">82</a><td> * and returns whether the version of Gecko we are on is the same or higher<tr><td><a name="l83" href="#l83">83</a><td> * than the given version. When we are not in a Firefox extension, this is null.<tr><td><a name="l84" href="#l84">84</a><td> * @private {(undefined|function((string|number)): boolean)}<tr><td><a name="l85" href="#l85">85</a><td> */<tr><td><a name="l86" href="#l86">86</a><td>bot.userAgent.FIREFOX_EXTENSION_IS_ENGINE_VERSION_;<tr><td><a name="l87" href="#l87">87</a><td><tr><td><a name="l88" href="#l88">88</a><td><tr><td><a name="l89" href="#l89">89</a><td>/**<tr><td><a name="l90" href="#l90">90</a><td> * When we are in a Firefox extension, this is a function that accepts a version<tr><td><a name="l91" href="#l91">91</a><td> * and returns whether the version of Firefox we are on is the same or higher<tr><td><a name="l92" href="#l92">92</a><td> * than the given version. When we are not in a Firefox extension, this is null.<tr><td><a name="l93" href="#l93">93</a><td> * @private {(undefined|function((string|number)): boolean)}<tr><td><a name="l94" href="#l94">94</a><td> */<tr><td><a name="l95" href="#l95">95</a><td>bot.userAgent.FIREFOX_EXTENSION_IS_PRODUCT_VERSION_;<tr><td><a name="l96" href="#l96">96</a><td><tr><td><a name="l97" href="#l97">97</a><td><tr><td><a name="l98" href="#l98">98</a><td>/**<tr><td><a name="l99" href="#l99">99</a><td> * Whether we are in a Firefox extension.<tr><td><a name="l100" href="#l100">100</a><td> *<tr><td><a name="l101" href="#l101">101</a><td> * @const<tr><td><a name="l102" href="#l102">102</a><td> * @type {boolean}<tr><td><a name="l103" href="#l103">103</a><td> */<tr><td><a name="l104" href="#l104">104</a><td>bot.userAgent.FIREFOX_EXTENSION = (function() {<tr><td><a name="l105" href="#l105">105</a><td> // False if this browser is not a Gecko browser.<tr><td><a name="l106" href="#l106">106</a><td> if (!goog.userAgent.GECKO) {<tr><td><a name="l107" href="#l107">107</a><td> return false;<tr><td><a name="l108" href="#l108">108</a><td> }<tr><td><a name="l109" href="#l109">109</a><td><tr><td><a name="l110" href="#l110">110</a><td> // False if this code isn&#39;t running in an extension.<tr><td><a name="l111" href="#l111">111</a><td> var Components = goog.global.Components;<tr><td><a name="l112" href="#l112">112</a><td> if (!Components) {<tr><td><a name="l113" href="#l113">113</a><td> return false;<tr><td><a name="l114" href="#l114">114</a><td> }<tr><td><a name="l115" href="#l115">115</a><td> try {<tr><td><a name="l116" href="#l116">116</a><td> if (!Components[&#39;classes&#39;]) {<tr><td><a name="l117" href="#l117">117</a><td> return false;<tr><td><a name="l118" href="#l118">118</a><td> }<tr><td><a name="l119" href="#l119">119</a><td> } catch (e) {<tr><td><a name="l120" href="#l120">120</a><td> return false;<tr><td><a name="l121" href="#l121">121</a><td> }<tr><td><a name="l122" href="#l122">122</a><td><tr><td><a name="l123" href="#l123">123</a><td> // Populate the version checker functions.<tr><td><a name="l124" href="#l124">124</a><td> var cc = Components[&#39;classes&#39;];<tr><td><a name="l125" href="#l125">125</a><td> var ci = Components[&#39;interfaces&#39;];<tr><td><a name="l126" href="#l126">126</a><td> var versionComparator = cc[&#39;@mozilla.org/xpcom/version-comparator;1&#39;][<tr><td><a name="l127" href="#l127">127</a><td> &#39;getService&#39;](ci[&#39;nsIVersionComparator&#39;]);<tr><td><a name="l128" href="#l128">128</a><td> var appInfo = cc[&#39;@mozilla.org/xre/app-info;1&#39;][&#39;getService&#39;](<tr><td><a name="l129" href="#l129">129</a><td> ci[&#39;nsIXULAppInfo&#39;]);<tr><td><a name="l130" href="#l130">130</a><td> var geckoVersion = appInfo[&#39;platformVersion&#39;];<tr><td><a name="l131" href="#l131">131</a><td> var firefoxVersion = appInfo[&#39;version&#39;];<tr><td><a name="l132" href="#l132">132</a><td><tr><td><a name="l133" href="#l133">133</a><td> bot.userAgent.FIREFOX_EXTENSION_IS_ENGINE_VERSION_ = function(version) {<tr><td><a name="l134" href="#l134">134</a><td> return versionComparator.compare(geckoVersion, &#39;&#39; + version) &gt;= 0;<tr><td><a name="l135" href="#l135">135</a><td> };<tr><td><a name="l136" href="#l136">136</a><td> bot.userAgent.FIREFOX_EXTENSION_IS_PRODUCT_VERSION_ = function(version) {<tr><td><a name="l137" href="#l137">137</a><td> return versionComparator.compare(firefoxVersion, &#39;&#39; + version) &gt;= 0;<tr><td><a name="l138" href="#l138">138</a><td> };<tr><td><a name="l139" href="#l139">139</a><td><tr><td><a name="l140" href="#l140">140</a><td> return true;<tr><td><a name="l141" href="#l141">141</a><td>})();<tr><td><a name="l142" href="#l142">142</a><td><tr><td><a name="l143" href="#l143">143</a><td><tr><td><a name="l144" href="#l144">144</a><td>/**<tr><td><a name="l145" href="#l145">145</a><td> * Whether we are on IOS.<tr><td><a name="l146" href="#l146">146</a><td> *<tr><td><a name="l147" href="#l147">147</a><td> * @const<tr><td><a name="l148" href="#l148">148</a><td> * @type {boolean}<tr><td><a name="l149" href="#l149">149</a><td> */<tr><td><a name="l150" href="#l150">150</a><td>bot.userAgent.IOS = goog.userAgent.product.IPAD ||<tr><td><a name="l151" href="#l151">151</a><td> goog.userAgent.product.IPHONE;<tr><td><a name="l152" href="#l152">152</a><td><tr><td><a name="l153" href="#l153">153</a><td><tr><td><a name="l154" href="#l154">154</a><td>/**<tr><td><a name="l155" href="#l155">155</a><td> * Whether we are on a mobile browser.<tr><td><a name="l156" href="#l156">156</a><td> *<tr><td><a name="l157" href="#l157">157</a><td> * @const<tr><td><a name="l158" href="#l158">158</a><td> * @type {boolean}<tr><td><a name="l159" href="#l159">159</a><td> */<tr><td><a name="l160" href="#l160">160</a><td>bot.userAgent.MOBILE = bot.userAgent.IOS || goog.userAgent.product.ANDROID;<tr><td><a name="l161" href="#l161">161</a><td><tr><td><a name="l162" href="#l162">162</a><td><tr><td><a name="l163" href="#l163">163</a><td>/**<tr><td><a name="l164" href="#l164">164</a><td> * Android Operating System Version.<tr><td><a name="l165" href="#l165">165</a><td> * @private {string}<tr><td><a name="l166" href="#l166">166</a><td> * @const<tr><td><a name="l167" href="#l167">167</a><td> */<tr><td><a name="l168" href="#l168">168</a><td>bot.userAgent.ANDROID_VERSION_ = (function() {<tr><td><a name="l169" href="#l169">169</a><td> if (goog.userAgent.product.ANDROID) {<tr><td><a name="l170" href="#l170">170</a><td> var userAgentString = goog.userAgent.getUserAgentString();<tr><td><a name="l171" href="#l171">171</a><td> var match = /Android\s+([0-9\.]+)/.exec(userAgentString);<tr><td><a name="l172" href="#l172">172</a><td> return match ? match[1] : &#39;0&#39;;<tr><td><a name="l173" href="#l173">173</a><td> } else {<tr><td><a name="l174" href="#l174">174</a><td> return &#39;0&#39;;<tr><td><a name="l175" href="#l175">175</a><td> }<tr><td><a name="l176" href="#l176">176</a><td>})();<tr><td><a name="l177" href="#l177">177</a><td><tr><td><a name="l178" href="#l178">178</a><td><tr><td><a name="l179" href="#l179">179</a><td>/**<tr><td><a name="l180" href="#l180">180</a><td> * Whether the current document is IE in a documentMode older than 8.<tr><td><a name="l181" href="#l181">181</a><td> * @type {boolean}<tr><td><a name="l182" href="#l182">182</a><td> * @const<tr><td><a name="l183" href="#l183">183</a><td> */<tr><td><a name="l184" href="#l184">184</a><td>bot.userAgent.IE_DOC_PRE8 = goog.userAgent.IE &amp;&amp;<tr><td><a name="l185" href="#l185">185</a><td> !goog.userAgent.isDocumentModeOrHigher(8);<tr><td><a name="l186" href="#l186">186</a><td><tr><td><a name="l187" href="#l187">187</a><td><tr><td><a name="l188" href="#l188">188</a><td>/**<tr><td><a name="l189" href="#l189">189</a><td> * Whether the current document is IE in IE9 (or newer) standards mode.<tr><td><a name="l190" href="#l190">190</a><td> * @type {boolean}<tr><td><a name="l191" href="#l191">191</a><td> * @const<tr><td><a name="l192" href="#l192">192</a><td> */<tr><td><a name="l193" href="#l193">193</a><td>bot.userAgent.IE_DOC_9 = goog.userAgent.isDocumentModeOrHigher(9);<tr><td><a name="l194" href="#l194">194</a><td><tr><td><a name="l195" href="#l195">195</a><td><tr><td><a name="l196" href="#l196">196</a><td>/**<tr><td><a name="l197" href="#l197">197</a><td> * Whether the current document is IE in a documentMode older than 9.<tr><td><a name="l198" href="#l198">198</a><td> * @type {boolean}<tr><td><a name="l199" href="#l199">199</a><td> * @const<tr><td><a name="l200" href="#l200">200</a><td> */<tr><td><a name="l201" href="#l201">201</a><td>bot.userAgent.IE_DOC_PRE9 = goog.userAgent.IE &amp;&amp;<tr><td><a name="l202" href="#l202">202</a><td> !goog.userAgent.isDocumentModeOrHigher(9);<tr><td><a name="l203" href="#l203">203</a><td><tr><td><a name="l204" href="#l204">204</a><td><tr><td><a name="l205" href="#l205">205</a><td>/**<tr><td><a name="l206" href="#l206">206</a><td> * Whether the current document is IE in IE10 (or newer) standards mode.<tr><td><a name="l207" href="#l207">207</a><td> * @type {boolean}<tr><td><a name="l208" href="#l208">208</a><td> * @const<tr><td><a name="l209" href="#l209">209</a><td> */<tr><td><a name="l210" href="#l210">210</a><td>bot.userAgent.IE_DOC_10 = goog.userAgent.isDocumentModeOrHigher(10);<tr><td><a name="l211" href="#l211">211</a><td><tr><td><a name="l212" href="#l212">212</a><td><tr><td><a name="l213" href="#l213">213</a><td>/**<tr><td><a name="l214" href="#l214">214</a><td> * Whether the current document is IE in a documentMode older than 10.<tr><td><a name="l215" href="#l215">215</a><td> * @type {boolean}<tr><td><a name="l216" href="#l216">216</a><td> * @const<tr><td><a name="l217" href="#l217">217</a><td> */<tr><td><a name="l218" href="#l218">218</a><td>bot.userAgent.IE_DOC_PRE10 = goog.userAgent.IE &amp;&amp;<tr><td><a name="l219" href="#l219">219</a><td> !goog.userAgent.isDocumentModeOrHigher(10);<tr><td><a name="l220" href="#l220">220</a><td><tr><td><a name="l221" href="#l221">221</a><td><tr><td><a name="l222" href="#l222">222</a><td>/**<tr><td><a name="l223" href="#l223">223</a><td> * Whether the current browser is Android pre-gingerbread.<tr><td><a name="l224" href="#l224">224</a><td> * @type {boolean}<tr><td><a name="l225" href="#l225">225</a><td> * @const<tr><td><a name="l226" href="#l226">226</a><td> */<tr><td><a name="l227" href="#l227">227</a><td>bot.userAgent.ANDROID_PRE_GINGERBREAD = goog.userAgent.product.ANDROID &amp;&amp;<tr><td><a name="l228" href="#l228">228</a><td> !bot.userAgent.isProductVersion(2.3);<tr><td><a name="l229" href="#l229">229</a><td><tr><td><a name="l230" href="#l230">230</a><td><tr><td><a name="l231" href="#l231">231</a><td>/**<tr><td><a name="l232" href="#l232">232</a><td> * Whether the current browser is Android pre-icecreamsandwich<tr><td><a name="l233" href="#l233">233</a><td> * @type {boolean}<tr><td><a name="l234" href="#l234">234</a><td> * @const<tr><td><a name="l235" href="#l235">235</a><td> */<tr><td><a name="l236" href="#l236">236</a><td>bot.userAgent.ANDROID_PRE_ICECREAMSANDWICH = goog.userAgent.product.ANDROID &amp;&amp;<tr><td><a name="l237" href="#l237">237</a><td> !bot.userAgent.isProductVersion(4);<tr><td><a name="l238" href="#l238">238</a><td><tr><td><a name="l239" href="#l239">239</a><td><tr><td><a name="l240" href="#l240">240</a><td>/**<tr><td><a name="l241" href="#l241">241</a><td> * Whether the current browser is Safari 6.<tr><td><a name="l242" href="#l242">242</a><td> * @type {boolean}<tr><td><a name="l243" href="#l243">243</a><td> * @const<tr><td><a name="l244" href="#l244">244</a><td> */<tr><td><a name="l245" href="#l245">245</a><td>bot.userAgent.SAFARI_6 = goog.userAgent.product.SAFARI &amp;&amp;<tr><td><a name="l246" href="#l246">246</a><td> bot.userAgent.isProductVersion(6);<tr><td><a name="l247" href="#l247">247</a><td><tr><td><a name="l248" href="#l248">248</a><td><tr><td><a name="l249" href="#l249">249</a><td>/**<tr><td><a name="l250" href="#l250">250</a><td> * Whether the current browser is Windows Phone.<tr><td><a name="l251" href="#l251">251</a><td> * @type {boolean}<tr><td><a name="l252" href="#l252">252</a><td> * @const<tr><td><a name="l253" href="#l253">253</a><td> */<tr><td><a name="l254" href="#l254">254</a><td>bot.userAgent.WINDOWS_PHONE = goog.userAgent.IE &amp;&amp;<tr><td><a name="l255" href="#l255">255</a><td> goog.userAgent.getUserAgentString().indexOf(&#39;IEMobile&#39;) != -1;</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../../../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../types.js"></script><script src="../../../dossier.js"></script>