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.
- package/CHANGES.md +20 -0
- package/README.md +8 -13
- package/builder.js +4 -3
- package/docs/class_webdriver_Alert.html +6 -6
- package/docs/class_webdriver_AlertPromise.html +6 -6
- package/docs/class_webdriver_UnhandledAlertError.html +4 -4
- package/docs/class_webdriver_WebDriver.html +39 -37
- package/docs/class_webdriver_WebDriver_Logs.html +3 -3
- package/docs/class_webdriver_WebDriver_Navigation.html +5 -5
- package/docs/class_webdriver_WebDriver_Options.html +9 -9
- package/docs/class_webdriver_WebDriver_TargetLocator.html +6 -6
- package/docs/class_webdriver_WebDriver_Timeouts.html +4 -4
- package/docs/class_webdriver_WebDriver_Window.html +6 -6
- package/docs/class_webdriver_WebElement.html +23 -23
- package/docs/class_webdriver_WebElementPromise.html +22 -22
- package/docs/class_webdriver_promise_CancellationError.html +3 -0
- package/docs/class_webdriver_promise_ControlFlow.html +32 -32
- package/docs/class_webdriver_promise_Deferred.html +7 -8
- package/docs/class_webdriver_promise_Frame_.html +14 -30
- package/docs/class_webdriver_promise_Promise.html +2 -2
- package/docs/class_webdriver_promise_Task_.html +12 -12
- package/docs/class_webdriver_until_Condition.html +3 -0
- package/docs/enum_webdriver_Key.html +1 -1
- package/docs/enum_webdriver_promise_ControlFlow_EventType.html +1 -1
- package/docs/enum_webdriver_promise_Deferred_State_.html +1 -1
- package/docs/index.html +8 -13
- package/docs/interface_webdriver_promise_Thenable.html +8 -10
- package/docs/license.html +1 -1
- package/docs/module_selenium-webdriver.html +2 -2
- package/docs/module_selenium-webdriver__base.html +1 -1
- package/docs/module_selenium-webdriver__base_class_Context.html +1 -1
- package/docs/module_selenium-webdriver_builder.html +1 -1
- package/docs/module_selenium-webdriver_builder_class_Builder.html +1 -1
- package/docs/module_selenium-webdriver_chrome.html +1 -1
- package/docs/module_selenium-webdriver_chrome_class_Driver.html +2 -2
- package/docs/module_selenium-webdriver_chrome_class_Options.html +2 -2
- package/docs/module_selenium-webdriver_chrome_class_ServiceBuilder.html +1 -1
- package/docs/module_selenium-webdriver_error.html +1 -1
- package/docs/module_selenium-webdriver_executors.html +1 -1
- package/docs/module_selenium-webdriver_firefox.html +1 -1
- package/docs/module_selenium-webdriver_firefox_binary.html +1 -1
- package/docs/module_selenium-webdriver_firefox_binary_class_Binary.html +1 -1
- package/docs/module_selenium-webdriver_firefox_class_Driver.html +2 -2
- package/docs/module_selenium-webdriver_firefox_class_Options.html +1 -1
- package/docs/module_selenium-webdriver_firefox_extension.html +1 -1
- package/docs/module_selenium-webdriver_firefox_profile.html +1 -1
- package/docs/module_selenium-webdriver_firefox_profile_class_Profile.html +1 -1
- package/docs/module_selenium-webdriver_http.html +1 -1
- package/docs/module_selenium-webdriver_http_class_HttpClient.html +1 -1
- package/docs/module_selenium-webdriver_http_util.html +1 -1
- package/docs/module_selenium-webdriver_io.html +1 -1
- package/docs/module_selenium-webdriver_io_exec.html +1 -1
- package/docs/module_selenium-webdriver_net.html +1 -1
- package/docs/module_selenium-webdriver_net_portprober.html +1 -1
- package/docs/module_selenium-webdriver_phantomjs.html +1 -1
- package/docs/module_selenium-webdriver_phantomjs_class_Driver.html +2 -2
- package/docs/module_selenium-webdriver_proxy.html +1 -1
- package/docs/module_selenium-webdriver_remote.html +1 -1
- package/docs/module_selenium-webdriver_remote_class_DriverService.html +2 -2
- package/docs/module_selenium-webdriver_remote_class_SeleniumServer.html +2 -2
- package/docs/module_selenium-webdriver_testing.html +16 -29
- package/docs/module_selenium-webdriver_testing_assert.html +1 -1
- package/docs/namespace_webdriver_promise.html +18 -20
- package/docs/namespace_webdriver_stacktrace.html +15 -15
- package/docs/namespace_webdriver_until.html +32 -0
- package/docs/source/_base.js.src.html +1 -1
- package/docs/source/builder.js.src.html +1 -1
- package/docs/source/chrome.js.src.html +1 -1
- package/docs/source/error.js.src.html +1 -1
- package/docs/source/executors.js.src.html +1 -1
- package/docs/source/firefox/binary.js.src.html +1 -1
- package/docs/source/firefox/extension.js.src.html +1 -1
- package/docs/source/firefox/index.js.src.html +1 -1
- package/docs/source/firefox/profile.js.src.html +1 -1
- package/docs/source/http/index.js.src.html +1 -1
- package/docs/source/http/util.js.src.html +1 -1
- package/docs/source/index.js.src.html +1 -1
- package/docs/source/io/exec.js.src.html +1 -1
- package/docs/source/io/index.js.src.html +1 -1
- package/docs/source/lib/atoms/error.js.src.html +1 -1
- package/docs/source/lib/atoms/json.js.src.html +1 -1
- package/docs/source/lib/atoms/response.js.src.html +1 -1
- package/docs/source/lib/atoms/userAgent.js.src.html +1 -1
- package/docs/source/lib/goog/array/array.js.src.html +1 -1
- package/docs/source/lib/goog/asserts/asserts.js.src.html +1 -1
- package/docs/source/lib/goog/async/nexttick.js.src.html +1 -1
- package/docs/source/lib/goog/async/run.js.src.html +1 -1
- package/docs/source/lib/goog/base.js.src.html +1 -1
- package/docs/source/lib/goog/debug/debug.js.src.html +1 -1
- package/docs/source/lib/goog/debug/entrypointregistry.js.src.html +1 -1
- package/docs/source/lib/goog/debug/error.js.src.html +1 -1
- package/docs/source/lib/goog/debug/logbuffer.js.src.html +1 -1
- package/docs/source/lib/goog/debug/logger.js.src.html +1 -1
- package/docs/source/lib/goog/debug/logrecord.js.src.html +1 -1
- package/docs/source/lib/goog/deps.js.src.html +1 -1
- package/docs/source/lib/goog/disposable/disposable.js.src.html +1 -1
- package/docs/source/lib/goog/disposable/idisposable.js.src.html +1 -1
- package/docs/source/lib/goog/dom/browserfeature.js.src.html +1 -1
- package/docs/source/lib/goog/dom/dom.js.src.html +1 -1
- package/docs/source/lib/goog/dom/nodetype.js.src.html +1 -1
- package/docs/source/lib/goog/dom/tagname.js.src.html +1 -1
- package/docs/source/lib/goog/dom/vendor.js.src.html +1 -1
- package/docs/source/lib/goog/events/browserevent.js.src.html +1 -1
- package/docs/source/lib/goog/events/browserfeature.js.src.html +1 -1
- package/docs/source/lib/goog/events/event.js.src.html +1 -1
- package/docs/source/lib/goog/events/eventid.js.src.html +1 -1
- package/docs/source/lib/goog/events/events.js.src.html +1 -1
- package/docs/source/lib/goog/events/eventtarget.js.src.html +1 -1
- package/docs/source/lib/goog/events/eventtype.js.src.html +1 -1
- package/docs/source/lib/goog/events/keycodes.js.src.html +1 -1
- package/docs/source/lib/goog/events/listenable.js.src.html +1 -1
- package/docs/source/lib/goog/events/listener.js.src.html +1 -1
- package/docs/source/lib/goog/events/listenermap.js.src.html +1 -1
- package/docs/source/lib/goog/functions/functions.js.src.html +1 -1
- package/docs/source/lib/goog/iter/iter.js.src.html +1 -1
- package/docs/source/lib/goog/json/json.js.src.html +1 -1
- package/docs/source/lib/goog/labs/testing/assertthat.js.src.html +1 -1
- package/docs/source/lib/goog/labs/testing/logicmatcher.js.src.html +1 -1
- package/docs/source/lib/goog/labs/testing/matcher.js.src.html +1 -1
- package/docs/source/lib/goog/labs/testing/numbermatcher.js.src.html +1 -1
- package/docs/source/lib/goog/labs/testing/objectmatcher.js.src.html +1 -1
- package/docs/source/lib/goog/labs/testing/stringmatcher.js.src.html +1 -1
- package/docs/source/lib/goog/labs/useragent/browser.js.src.html +1 -1
- package/docs/source/lib/goog/labs/useragent/engine.js.src.html +1 -1
- package/docs/source/lib/goog/labs/useragent/util.js.src.html +1 -1
- package/docs/source/lib/goog/math/box.js.src.html +1 -1
- package/docs/source/lib/goog/math/coordinate.js.src.html +1 -1
- package/docs/source/lib/goog/math/math.js.src.html +1 -1
- package/docs/source/lib/goog/math/rect.js.src.html +1 -1
- package/docs/source/lib/goog/math/size.js.src.html +1 -1
- package/docs/source/lib/goog/net/wrapperxmlhttpfactory.js.src.html +1 -1
- package/docs/source/lib/goog/net/xhrlike.js.src.html +1 -1
- package/docs/source/lib/goog/net/xmlhttp.js.src.html +1 -1
- package/docs/source/lib/goog/net/xmlhttpfactory.js.src.html +1 -1
- package/docs/source/lib/goog/object/object.js.src.html +1 -1
- package/docs/source/lib/goog/reflect/reflect.js.src.html +1 -1
- package/docs/source/lib/goog/string/string.js.src.html +1 -1
- package/docs/source/lib/goog/structs/collection.js.src.html +1 -1
- package/docs/source/lib/goog/structs/map.js.src.html +1 -1
- package/docs/source/lib/goog/structs/set.js.src.html +1 -1
- package/docs/source/lib/goog/structs/structs.js.src.html +1 -1
- package/docs/source/lib/goog/style/style.js.src.html +1 -1
- package/docs/source/lib/goog/testing/asserts.js.src.html +1 -1
- package/docs/source/lib/goog/testing/asynctestcase.js.src.html +1 -1
- package/docs/source/lib/goog/testing/events/events.js.src.html +1 -1
- package/docs/source/lib/goog/testing/functionmock.js.src.html +1 -1
- package/docs/source/lib/goog/testing/jsunit.js.src.html +1 -1
- package/docs/source/lib/goog/testing/loosemock.js.src.html +1 -1
- package/docs/source/lib/goog/testing/mock.js.src.html +1 -1
- package/docs/source/lib/goog/testing/mockclock.js.src.html +1 -1
- package/docs/source/lib/goog/testing/mockcontrol.js.src.html +1 -1
- package/docs/source/lib/goog/testing/mockinterface.js.src.html +1 -1
- package/docs/source/lib/goog/testing/mockmatchers.js.src.html +1 -1
- package/docs/source/lib/goog/testing/objectpropertystring.js.src.html +1 -1
- package/docs/source/lib/goog/testing/propertyreplacer.js.src.html +1 -1
- package/docs/source/lib/goog/testing/recordfunction.js.src.html +1 -1
- package/docs/source/lib/goog/testing/stacktrace.js.src.html +1 -1
- package/docs/source/lib/goog/testing/strictmock.js.src.html +1 -1
- package/docs/source/lib/goog/testing/testcase.js.src.html +1 -1
- package/docs/source/lib/goog/testing/testrunner.js.src.html +1 -1
- package/docs/source/lib/goog/testing/watchers.js.src.html +1 -1
- package/docs/source/lib/goog/uri/uri.js.src.html +1 -1
- package/docs/source/lib/goog/uri/utils.js.src.html +1 -1
- package/docs/source/lib/goog/useragent/product.js.src.html +1 -1
- package/docs/source/lib/goog/useragent/product_isversion.js.src.html +1 -1
- package/docs/source/lib/goog/useragent/useragent.js.src.html +1 -1
- package/docs/source/lib/webdriver/abstractbuilder.js.src.html +1 -1
- package/docs/source/lib/webdriver/actionsequence.js.src.html +1 -1
- package/docs/source/lib/webdriver/builder.js.src.html +1 -1
- package/docs/source/lib/webdriver/button.js.src.html +1 -1
- package/docs/source/lib/webdriver/capabilities.js.src.html +1 -1
- package/docs/source/lib/webdriver/command.js.src.html +1 -1
- package/docs/source/lib/webdriver/events.js.src.html +1 -1
- package/docs/source/lib/webdriver/firefoxdomexecutor.js.src.html +1 -1
- package/docs/source/lib/webdriver/http/corsclient.js.src.html +1 -1
- package/docs/source/lib/webdriver/http/http.js.src.html +1 -1
- package/docs/source/lib/webdriver/http/xhrclient.js.src.html +1 -1
- package/docs/source/lib/webdriver/key.js.src.html +1 -1
- package/docs/source/lib/webdriver/locators.js.src.html +1 -1
- package/docs/source/lib/webdriver/logging.js.src.html +1 -1
- package/docs/source/lib/webdriver/process.js.src.html +1 -1
- package/docs/source/lib/webdriver/promise.js.src.html +1 -1
- package/docs/source/lib/webdriver/session.js.src.html +1 -1
- package/docs/source/lib/webdriver/stacktrace.js.src.html +1 -1
- package/docs/source/lib/webdriver/testing/asserts.js.src.html +1 -1
- package/docs/source/lib/webdriver/testing/testcase.js.src.html +1 -1
- package/docs/source/lib/webdriver/until.js.src.html +1 -0
- package/docs/source/lib/webdriver/webdriver.js.src.html +1 -1
- package/docs/source/net/index.js.src.html +1 -1
- package/docs/source/net/portprober.js.src.html +1 -1
- package/docs/source/phantomjs.js.src.html +1 -1
- package/docs/source/proxy.js.src.html +1 -1
- package/docs/source/remote/index.js.src.html +1 -1
- package/docs/source/testing/assert.js.src.html +1 -1
- package/docs/source/testing/index.js.src.html +1 -1
- package/docs/types.js +1 -1
- package/example/google_search.js +9 -17
- package/example/google_search_generator.js +6 -7
- package/example/google_search_test.js +10 -18
- package/example/parallel_flows.js +4 -7
- package/index.js +6 -0
- package/lib/firefox/webdriver.xpi +0 -0
- package/lib/goog/deps.js +7 -5
- package/lib/test/index.js +0 -8
- package/lib/webdriver/promise.js +263 -251
- package/lib/webdriver/stacktrace.js +15 -1
- package/lib/webdriver/test/promise_flow_test.js +82 -76
- package/lib/webdriver/test/promise_test.js +22 -62
- package/lib/webdriver/test/stacktrace_test.js +18 -0
- package/lib/webdriver/test/until_test.js +388 -0
- package/lib/webdriver/test/webdriver_test.js +41 -0
- package/lib/webdriver/until.js +408 -0
- package/lib/webdriver/webdriver.js +91 -29
- package/package.json +2 -2
- package/test/element_finding_test.js +6 -6
- package/test/http/util_test.js +4 -5
- package/test/page_loading_test.js +7 -7
- package/test/stale_element_test.js +2 -10
- package/testing/index.js +9 -22
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.promise.Deferred</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Class webdriver.promise.Deferred.<code class="type"><T></code></h1><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
1
|
+
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.promise.Deferred</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Class webdriver.promise.Deferred.<code class="type"><T></code></h1><a class="source" href="source/lib/webdriver/promise.js.src.html#l323">code »</a><pre><code>webdriver.promise.Promise.<(T|null)>
|
|
2
2
|
└ webdriver.promise.Deferred</code></pre><dl><dt>All implemented interfaces:<dd><code><a href="">webdriver.promise.Thenable.<(T|null)></a></code></dl></header><section><p>Represents a value that will be resolved at some point in the future. This
|
|
3
3
|
class represents the protected "producer" half of a Promise - each Deferred
|
|
4
4
|
has a <code >promise</code> property that may be returned to consumers for
|
|
@@ -11,17 +11,16 @@
|
|
|
11
11
|
|
|
12
12
|
<p>If this Deferred is cancelled, the cancellation reason will be forward to
|
|
13
13
|
the Deferred's canceller function (if provided). The canceller may return a
|
|
14
|
-
truth-y value to override the reason provided for rejection.<h2>Constructor</h2><div class="ctor wrap-details public"><div><div class="ctor"><span class="member">webdriver.promise.Deferred <span class="args">(
|
|
15
|
-
computation of this instance's value.<dt>opt_flow: <code class="type"><a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a>=</code><dd>The control flow
|
|
14
|
+
truth-y value to override the reason provided for rejection.<h2>Constructor</h2><div class="ctor wrap-details public"><div><div class="ctor"><span class="member">webdriver.promise.Deferred <span class="args">( opt_flow )</span></span></div><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_flow: <code class="type"><a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a>=</code><dd>The control flow
|
|
16
15
|
this instance was created under. This should only be provided during
|
|
17
|
-
unit tests.</dl></table></div></div></div></section><section><h2>Enumerations</h2><div class="type-summary"><table><tbody><tr><td><dl><dt><a href="enum_webdriver_promise_Deferred_State_.html">webdriver.promise.Deferred.State_</a><dd>The three states a <code class="type"><a href="class_webdriver_promise_Deferred.html">webdriver.promise.Deferred</a></code> object may be in.</dl></table></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="typedefs"><h2>Type Definitions</h2><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
16
|
+
unit tests.</dl></table></div></div></div></section><section><h2>Enumerations</h2><div class="type-summary"><table><tbody><tr><td><dl><dt><a href="enum_webdriver_promise_Deferred_State_.html">webdriver.promise.Deferred.State_</a><dd>The three states a <code class="type"><a href="class_webdriver_promise_Deferred.html">webdriver.promise.Deferred</a></code> object may be in.</dl></table></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="typedefs"><h2>Type Definitions</h2><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l599">code »</a><a class="member" name="webdriver.promise.Deferred.Listener_">webdriver.promise.Deferred.Listener_</a> : <code class="type">{callback: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">Function</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), errback: (<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">Function</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined">undefined</a>), fulfill: function(*), reject: function(*)}</code></div><div>Type definition for a listener registered on a Deferred object.</div></summary></details></div></div></section><section id="instance-methods"><h2>Instance Methods</h2><h3>Defined in <code class="type">webdriver.promise.Deferred</code></h3><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l569">code »</a><span class="member"><a name="errback">errback</a> <span class="args">( opt_error )</span></span></div><p>Rejects this promise. If the error is itself a promise, this instance will
|
|
18
17
|
be chained to it and be rejected with the error's resolved value.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_error: <code class="type">*=</code><dd>The rejection reason, typically either a
|
|
19
|
-
<code >Error</code> or a <code >string</code>.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
18
|
+
<code >Error</code> or a <code >string</code>.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l568">code »</a><span class="member"><a name="fulfill">fulfill</a> <span class="args">( opt_value )</span></span></div><p>Resolves this promise with the given value. If the value is itself a
|
|
20
19
|
promise and not a reference to this deferred, this instance will wait for
|
|
21
|
-
it before resolving.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_value: <code class="type">T=</code><dd>The fulfilled value.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
20
|
+
it before resolving.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_value: <code class="type">T=</code><dd>The fulfilled value.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l569">code »</a><span class="member"><a name="reject">reject</a> <span class="args">( opt_error )</span></span></div><p>Rejects this promise. If the error is itself a promise, this instance will
|
|
22
21
|
be chained to it and be rejected with the error's resolved value.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_error: <code class="type">*=</code><dd>The rejection reason, typically either a
|
|
23
|
-
<code >Error</code> or a <code >string</code>.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
22
|
+
<code >Error</code> or a <code >string</code>.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l574">code »</a><span class="member"><a name="removeAll">removeAll</a> <span class="args">( )</span></span></div><p>Removes all of the listeners previously registered on this deferred.</summary><div class="info"><table><tbody><tr><th>Throws<tr><td><dl><dt><code class="type"><a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Error">Error</a></code><dd>If this deferred has already been resolved.</dl></table></div></details></div></div><h3>Defined in <code class="type"><a href="class_webdriver_promise_Promise.html#webdriver.promise.Promise.<(T|null)>">webdriver.promise.Promise.<(T|null)></a></code></h3><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l262">code »</a><span class="member"><a name="cancel">cancel</a> <span class="args">( reason )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>reason</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l268">code »</a><span class="member"><a name="isPending">isPending</a> <span class="args">( )</span> ⇒ <code class="type">boolean</code></span></div></summary></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l274">code »</a><span class="member"><a name="then">then</a> <span class="args">( opt_callback, opt_errback )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_callback<dt>opt_errback</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l281">code »</a><span class="member"><a name="thenCatch">thenCatch</a> <span class="args">( errback )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>errback</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l287">code »</a><span class="member"><a name="thenFinally">thenFinally</a> <span class="args">( callback )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>callback</dl></table></div></details></div></div></section><section id="instance-properties"><h2>Instance Properties</h2><h3>Defined in <code class="type">webdriver.promise.Deferred</code></h3><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l337">code »</a><span class="member"><a name="parent_">parent_</a> : <code class="type"><a href="class_webdriver_promise_Deferred.html">webdriver.promise.Deferred</a></code></span></div><p>The deferred this instance is chained from, if any.</summary></details></div></div><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l564">code »</a><span class="member"><a name="webdriver.promise.Deferred.prototype.promise">webdriver.promise.Deferred.prototype.promise</a> : <code class="type">webdriver.promise.Promise.<T></code></span></div><p>Represents the eventual value of a completed operation. Each promise may be
|
|
24
23
|
in one of three states: pending, resolved, or rejected. Each promise starts
|
|
25
24
|
in the pending state and may make a single transition to either a
|
|
26
25
|
fulfilled or rejected state, at which point the promise is considered
|
|
27
|
-
resolved.</summary></details></div></div></section><section id="static-properties"><h2>Static Properties</h2><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
26
|
+
resolved.</summary></details></div></div></section><section id="static-properties"><h2>Static Properties</h2><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l323">code »</a><span class="member"><a name="webdriver.promise.Deferred.superClass_">webdriver.promise.Deferred.superClass_</a> : <code class="type"><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise.prototype</a></code></span></div></summary></details></div></div></section></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,14 +1,12 @@
|
|
|
1
|
-
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.promise.Frame_</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Class webdriver.promise.Frame_</h1><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
2
|
-
└ <a href="class_webdriver_promise_Deferred.html">webdriver.promise.Deferred</a>
|
|
3
|
-
└ <a href="class_webdriver_promise_Node_.html">webdriver.promise.Node_</a>
|
|
4
|
-
└ webdriver.promise.Frame_</code></pre><dl><dt>All implemented interfaces:<dd><code><a href="">webdriver.promise.Thenable.<(T|null)></a></code></dl></header><section><p>An execution frame within a <code class="type"><a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a></code>. Each
|
|
1
|
+
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.promise.Frame_</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Class webdriver.promise.Frame_</h1><a class="source" href="source/lib/webdriver/promise.js.src.html#l1787">code »</a></header><section><p>An execution frame within a <code class="type"><a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a></code>. Each
|
|
5
2
|
frame represents the execution context for either a
|
|
6
3
|
<code class="type"><a href="class_webdriver_promise_Task_.html">webdriver.promise.Task_</a></code> or a callback on a
|
|
7
4
|
<code class="type"><a href="class_webdriver_promise_Deferred.html">webdriver.promise.Deferred</a></code>.
|
|
8
5
|
|
|
9
6
|
<p>Each frame may contain sub-frames. If child N is a sub-frame, then the
|
|
10
7
|
items queued within it are given priority over child N+1.<h2>Constructor</h2><div class="ctor wrap-details private"><div><div class="ctor"><span class="member">webdriver.promise.Frame_ <span class="args">( flow )</span></span></div><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>flow: <code class="type">!<a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a></code><dd>The flow this instance belongs
|
|
11
|
-
to.</dl></table></div></div></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="instance-methods"><h2>Instance Methods</h2><
|
|
8
|
+
to.</dl></table></div></div></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="instance-methods"><h2>Instance Methods</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1878">code »</a><span class="member"><a name="abort">abort</a> <span class="args">( error )</span></span></div><p>Aborts the execution of this frame, cancelling all outstanding tasks
|
|
9
|
+
scheduled within this frame.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>error: <code class="type">*</code><dd>The error that triggered this abortion.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1981">code »</a><span class="member"><a name="addChild">addChild</a> <span class="args">( node )</span></span></div><p>Adds a new node to this frame.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>node: <code class="type">!(<a href="class_webdriver_promise_Frame_.html">webdriver.promise.Frame_</a>|<a href="class_webdriver_promise_Task_.html">webdriver.promise.Task_</a>)</code><dd>The node to insert.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1942">code »</a><span class="member"><a name="cancelRemainingTasks">cancelRemainingTasks</a> <span class="args">( reason )</span></span></div><p>Marks all of the tasks that are descendants of this frame in the execution
|
|
12
10
|
tree as cancelled. This is necessary for callbacks scheduled asynchronous.
|
|
13
11
|
For example:
|
|
14
12
|
|
|
@@ -25,35 +23,21 @@
|
|
|
25
23
|
});
|
|
26
24
|
});
|
|
27
25
|
// flow failed: Error: boom
|
|
28
|
-
// task failed!
|
|
29
|
-
// task failure: Error: boom</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
within this frame, if any.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
33
|
-
|
|
34
|
-
be chained to it and be rejected with the error's resolved value.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_error: <code class="type">*=</code><dd>The rejection reason, typically either a
|
|
35
|
-
<code >Error</code> or a <code >string</code>.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l546">code »</a><span class="member"><a name="fulfill">fulfill</a> <span class="args">( opt_value )</span></span></div><p>Resolves this promise with the given value. If the value is itself a
|
|
36
|
-
promise and not a reference to this deferred, this instance will wait for
|
|
37
|
-
it before resolving.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_value: <code class="type">T=</code><dd>The fulfilled value.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l552">code »</a><span class="member"><a name="removeAll">removeAll</a> <span class="args">( )</span></span></div><p>Removes all of the listeners previously registered on this deferred.</summary><div class="info"><table><tbody><tr><th>Throws<tr><td><dl><dt><code class="type"><a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Error">Error</a></code><dd>If this deferred has already been resolved.</dl></table></div></details></div></div><h3>Defined in <code class="type"><a href="class_webdriver_promise_Promise.html#webdriver.promise.Promise.<(T|null)>">webdriver.promise.Promise.<(T|null)></a></code></h3><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l246">code »</a><span class="member"><a name="cancel">cancel</a> <span class="args">( reason )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>reason</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l252">code »</a><span class="member"><a name="isPending">isPending</a> <span class="args">( )</span> ⇒ <code class="type">boolean</code></span></div></summary></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l258">code »</a><span class="member"><a name="then">then</a> <span class="args">( opt_callback, opt_errback )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_callback<dt>opt_errback</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l265">code »</a><span class="member"><a name="thenCatch">thenCatch</a> <span class="args">( errback )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>errback</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l271">code »</a><span class="member"><a name="thenFinally">thenFinally</a> <span class="args">( callback )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>callback</dl></table></div></details></div></div></section><section id="instance-properties"><h2>Instance Properties</h2><h3>Defined in <code class="type">webdriver.promise.Frame_</code></h3><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1833">code »</a><span class="member"><a name="children_">children_</a> : <code class="type">!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></code></span></div></summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1863">code »</a><span class="member"><a name="isActive_">isActive_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Whether this frame is active. A frame is considered active once one of its
|
|
38
|
-
descendants has been removed for execution.
|
|
26
|
+
// task failed! CancelledTaskError: Task discarded due to a previous
|
|
27
|
+
// task failure: Error: boom</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>reason: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>The cancellation reason.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1898">code »</a><span class="member"><a name="close">close</a> <span class="args">( )</span></span></div><p>Signals that this frame has successfully finished executing.</summary></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l2013">code »</a><span class="member"><a name="getFirstChild">getFirstChild</a> <span class="args">( )</span> ⇒ <code class="type">(<a href="class_webdriver_promise_Frame_.html">webdriver.promise.Frame_</a>|<a href="class_webdriver_promise_Task_.html">webdriver.promise.Task_</a>)</code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>This frame's
|
|
28
|
+
fist child.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1847">code »</a><span class="member"><a name="getParent">getParent</a> <span class="args">( )</span> ⇒ <code class="type"><a href="class_webdriver_promise_Frame_.html">webdriver.promise.Frame_</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>This frame's parent, if any.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1962">code »</a><span class="member"><a name="getPendingTask">getPendingTask</a> <span class="args">( )</span> ⇒ <code class="type"><a href="class_webdriver_promise_Task_.html">webdriver.promise.Task_</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>The task currently executing
|
|
29
|
+
within this frame, if any.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1863">code »</a><span class="member"><a name="getRoot">getRoot</a> <span class="args">( )</span> ⇒ <code class="type">!<a href="class_webdriver_promise_Frame_.html">webdriver.promise.Frame_</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>The root of this frame's tree.</dl></table></div></details></div></div><div class="wrap-details private"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1911">code »</a><span class="member"><a name="notify_">notify_</a> <span class="args">( fn, opt_error )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>fn: <code class="type">?(function(*)|function())</code><dd>The function to notify.<dt>opt_error: <code class="type">*=</code><dd>Value to pass to the notified function, if any.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l2025">code »</a><span class="member"><a name="removeChild">removeChild</a> <span class="args">( child )</span></span></div><p>Removes a child from this frame.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>child: <code class="type">!(<a href="class_webdriver_promise_Frame_.html">webdriver.promise.Frame_</a>|<a href="class_webdriver_promise_Task_.html">webdriver.promise.Task_</a>)</code><dd>The child to remove.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1855">code »</a><span class="member"><a name="setParent">setParent</a> <span class="args">( parent )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>parent: <code class="type"><a href="class_webdriver_promise_Frame_.html">webdriver.promise.Frame_</a></code><dd>This frame's new parent.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1971">code »</a><span class="member"><a name="setPendingTask">setPendingTask</a> <span class="args">( task )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>task: <code class="type"><a href="class_webdriver_promise_Task_.html">webdriver.promise.Task_</a></code><dd>The task currently
|
|
30
|
+
executing within this frame, if any.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l2038">code »</a><span class="member"><a name="toString">toString</a> <span class="args">( )</span> ⇒ <code class="type">string</code></span></div></summary></details></div></div></section><section id="instance-properties"><h2>Instance Properties</h2><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1797">code »</a><span class="member"><a name="children_">children_</a> : <code class="type">!<a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></code></span></div></summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1789">code »</a><span class="member"><a name="flow_">flow_</a> : <code class="type">!<a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a></code></span></div></summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1827">code »</a><span class="member"><a name="isLocked_">isLocked_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Whether this frame is currently locked. A locked frame represents an
|
|
31
|
+
executed function that has scheduled all of its tasks.
|
|
39
32
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
33
|
+
<p>Once a frame becomes locked, any new frames which are added as children
|
|
34
|
+
represent interrupts (such as a <code class="type"><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code>
|
|
35
|
+
callback) whose tasks must be given priority over those already scheduled
|
|
36
|
+
within this frame. For example:
|
|
44
37
|
<code><pre>
|
|
45
38
|
var flow = webdriver.promise.controlFlow();
|
|
46
39
|
flow.execute('start here', goog.nullFunction).then(function() {
|
|
47
40
|
flow.execute('this should execute 2nd', goog.nullFunction);
|
|
48
41
|
});
|
|
49
42
|
flow.execute('this should execute last', goog.nullFunction);
|
|
50
|
-
</pre></code></summary></details></div></div><div class="wrap-details
|
|
51
|
-
or task function which has run to completion and scheduled all of its tasks.
|
|
52
|
-
|
|
53
|
-
<p>Once a frame becomes <code class="type"><a class="unresolved-link">active</a></code>, any new frames which are
|
|
54
|
-
added represent callbacks on a <code class="type"><a href="class_webdriver_promise_Deferred.html">webdriver.promise.Deferred</a></code>, whose
|
|
55
|
-
tasks must be given priority over previously scheduled tasks.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1883">code »</a><span class="member"><a name="lastInsertedChild_">lastInsertedChild_</a> : <code class="type"><a href="class_webdriver_promise_Node_.html">webdriver.promise.Node_</a></code></span></div><p>A reference to the last node inserted in this frame.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1842">code »</a><span class="member"><a name="pendingTask_">pendingTask_</a> : <code class="type"><a href="class_webdriver_promise_Task_.html">webdriver.promise.Task_</a></code></span></div><p>The task currently being executed within this frame.</summary></details></div></div><h3>Defined in <code class="type"><a href="class_webdriver_promise_Node_.html">webdriver.promise.Node_</a></code></h3><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1773">code »</a><span class="member"><a name="parent_">parent_</a> : <code class="type"><a href="class_webdriver_promise_Node_.html">webdriver.promise.Node_</a></code></span></div><p>This node's parent.</summary></details></div></div><h3>Defined in <code class="type"><a href="class_webdriver_promise_Deferred.html">webdriver.promise.Deferred</a></code></h3><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l542">code »</a><span class="member"><a name="webdriver.promise.Deferred.prototype.promise">webdriver.promise.Deferred.prototype.promise</a> : <code class="type">webdriver.promise.Promise.<T></code></span></div><p>Represents the eventual value of a completed operation. Each promise may be
|
|
56
|
-
in one of three states: pending, resolved, or rejected. Each promise starts
|
|
57
|
-
in the pending state and may make a single transition to either a
|
|
58
|
-
fulfilled or rejected state, at which point the promise is considered
|
|
59
|
-
resolved.</summary></details></div></div></section><section id="static-properties"><h2>Static Properties</h2><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1818">code »</a><span class="member"><a name="webdriver.promise.Frame_.superClass_">webdriver.promise.Frame_.superClass_</a> : <code class="type"><a href="class_webdriver_promise_Node_.html">webdriver.promise.Node_.prototype</a></code></span></div></summary></details></div></div></section></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>
|
|
43
|
+
</pre></code></summary></details></div></div><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1830">code »</a><span class="member"><a name="isWaiting">isWaiting</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div></summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1801">code »</a><span class="member"><a name="lastInsertedChild_">lastInsertedChild_</a> : <code class="type">(<a href="class_webdriver_promise_Frame_.html">webdriver.promise.Frame_</a>|<a href="class_webdriver_promise_Task_.html">webdriver.promise.Task_</a>)</code></span></div></summary></details></div></div><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1842">code »</a><span class="member"><a name="onAbort">onAbort</a> : <code class="type">?function(*)</code></span></div><p>The function to notify if this frame is aborted with an error.</summary></details></div></div><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1836">code »</a><span class="member"><a name="onComplete">onComplete</a> : <code class="type">?function()</code></span></div><p>The function to notify if this frame executes without error.</summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1792">code »</a><span class="member"><a name="parent_">parent_</a> : <code class="type"><a href="class_webdriver_promise_Frame_.html">webdriver.promise.Frame_</a></code></span></div></summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l1807">code »</a><span class="member"><a name="pendingTask_">pendingTask_</a> : <code class="type"><a href="class_webdriver_promise_Task_.html">webdriver.promise.Task_</a></code></span></div><p>The task currently being executed within this frame.</summary></details></div></div></section></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,5 +1,5 @@
|
|
|
1
|
-
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.promise.Promise</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Class webdriver.promise.Promise.<code class="type"><T></code></h1><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
1
|
+
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.promise.Promise</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Class webdriver.promise.Promise.<code class="type"><T></code></h1><a class="source" href="source/lib/webdriver/promise.js.src.html#l257">code »</a><dl><dt>All implemented interfaces:<dd><code><a href="">webdriver.promise.Thenable.<(T|null)></a></code></dl></header><section><p>Represents the eventual value of a completed operation. Each promise may be
|
|
2
2
|
in one of three states: pending, resolved, or rejected. Each promise starts
|
|
3
3
|
in the pending state and may make a single transition to either a
|
|
4
4
|
fulfilled or rejected state, at which point the promise is considered
|
|
5
|
-
resolved.<h2>Constructor</h2><div class="ctor wrap-details public"><div><div class="ctor"><span class="member">webdriver.promise.Promise <span class="args">( )</span></span></div></div></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="instance-methods"><h2>Instance Methods</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
5
|
+
resolved.<h2>Constructor</h2><div class="ctor wrap-details public"><div><div class="ctor"><span class="member">webdriver.promise.Promise <span class="args">( )</span></span></div></div></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="instance-methods"><h2>Instance Methods</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l262">code »</a><span class="member"><a name="cancel">cancel</a> <span class="args">( reason )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>reason</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l268">code »</a><span class="member"><a name="isPending">isPending</a> <span class="args">( )</span> ⇒ <code class="type">boolean</code></span></div></summary></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l274">code »</a><span class="member"><a name="then">then</a> <span class="args">( opt_callback, opt_errback )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_callback<dt>opt_errback</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l281">code »</a><span class="member"><a name="thenCatch">thenCatch</a> <span class="args">( errback )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>errback</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l287">code »</a><span class="member"><a name="thenFinally">thenFinally</a> <span class="args">( callback )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>callback</dl></table></div></details></div></div></section></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,18 +1,18 @@
|
|
|
1
|
-
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.promise.Task_</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Class webdriver.promise.Task_
|
|
2
|
-
└
|
|
3
|
-
└ <a href="
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
when this task was scheduled.</dl></table></div></div></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="instance-methods"><h2>Instance Methods</h2><h3>Defined in <code class="type">webdriver.promise.Task_</code></h3><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
1
|
+
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.promise.Task_</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Class webdriver.promise.Task_.<code class="type"><T></code></h1><a class="source" href="source/lib/webdriver/promise.js.src.html#l2063">code »</a><pre><code>webdriver.promise.Promise.<(T|null)>
|
|
2
|
+
└ webdriver.promise.Deferred.<(T|null)>
|
|
3
|
+
└ webdriver.promise.Task_</code></pre><dl><dt>All implemented interfaces:<dd><code><a href="">webdriver.promise.Thenable.<(T|null)></a></code></dl></header><section><p>A task to be executed by a <code class="type"><a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a></code>.<h2>Constructor</h2><div class="ctor wrap-details private"><div><div class="ctor"><span class="member">webdriver.promise.Task_ <span class="args">( flow, fn, description, snapshot )</span></span></div><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>flow: <code class="type">!<a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a></code><dd>The flow this instances belongs
|
|
4
|
+
to.<dt>fn: <code class="type">function(): (T|!<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>.<T>)</code><dd>The function to
|
|
5
|
+
call when the task executes. If it returns a
|
|
6
|
+
<code class="type"><a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a></code>, the flow will wait for it to be
|
|
7
|
+
resolved before starting the next task.<dt>description: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>A description of the task for debugging.<dt>snapshot: <code class="type">!<a href="class_webdriver_stacktrace_Snapshot.html">webdriver.stacktrace.Snapshot</a></code><dd>A snapshot of the stack
|
|
8
|
+
when this task was scheduled.</dl></table></div></div></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="instance-methods"><h2>Instance Methods</h2><h3>Defined in <code class="type">webdriver.promise.Task_</code></h3><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l2069">code »</a><span class="member"><a name="execute">execute</a> <span class="args">( )</span> ⇒ <code class="type">(T|webdriver.promise.Promise.<T>)</code></span></div></summary></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l2081">code »</a><span class="member"><a name="getDescription">getDescription</a> <span class="args">( )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>This task's description.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l2087">code »</a><span class="member"><a name="toString">toString</a> <span class="args">( )</span> ⇒ <code class="type">string</code></span></div></summary></details></div></div><h3>Defined in <code class="type"><a href="class_webdriver_promise_Deferred.html#webdriver.promise.Deferred.<(T|null)>">webdriver.promise.Deferred.<(T|null)></a></code></h3><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l569">code »</a><span class="member"><a name="errback">errback</a> <span class="args">( opt_error )</span></span></div><p>Rejects this promise. If the error is itself a promise, this instance will
|
|
9
9
|
be chained to it and be rejected with the error's resolved value.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_error: <code class="type">*=</code><dd>The rejection reason, typically either a
|
|
10
|
-
<code >Error</code> or a <code >string</code>.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
10
|
+
<code >Error</code> or a <code >string</code>.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l568">code »</a><span class="member"><a name="fulfill">fulfill</a> <span class="args">( opt_value )</span></span></div><p>Resolves this promise with the given value. If the value is itself a
|
|
11
11
|
promise and not a reference to this deferred, this instance will wait for
|
|
12
|
-
it before resolving.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_value: <code class="type">T=</code><dd>The fulfilled value.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
12
|
+
it before resolving.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_value: <code class="type">T=</code><dd>The fulfilled value.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l569">code »</a><span class="member"><a name="reject">reject</a> <span class="args">( opt_error )</span></span></div><p>Rejects this promise. If the error is itself a promise, this instance will
|
|
13
13
|
be chained to it and be rejected with the error's resolved value.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_error: <code class="type">*=</code><dd>The rejection reason, typically either a
|
|
14
|
-
<code >Error</code> or a <code >string</code>.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
14
|
+
<code >Error</code> or a <code >string</code>.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l574">code »</a><span class="member"><a name="removeAll">removeAll</a> <span class="args">( )</span></span></div><p>Removes all of the listeners previously registered on this deferred.</summary><div class="info"><table><tbody><tr><th>Throws<tr><td><dl><dt><code class="type"><a href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Error">Error</a></code><dd>If this deferred has already been resolved.</dl></table></div></details></div></div><h3>Defined in <code class="type"><a href="class_webdriver_promise_Promise.html#webdriver.promise.Promise.<(T|null)>">webdriver.promise.Promise.<(T|null)></a></code></h3><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l262">code »</a><span class="member"><a name="cancel">cancel</a> <span class="args">( reason )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>reason</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l268">code »</a><span class="member"><a name="isPending">isPending</a> <span class="args">( )</span> ⇒ <code class="type">boolean</code></span></div></summary></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l274">code »</a><span class="member"><a name="then">then</a> <span class="args">( opt_callback, opt_errback )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_callback<dt>opt_errback</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l281">code »</a><span class="member"><a name="thenCatch">thenCatch</a> <span class="args">( errback )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>errback</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l287">code »</a><span class="member"><a name="thenFinally">thenFinally</a> <span class="args">( callback )</span></span></div></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>callback</dl></table></div></details></div></div></section><section id="instance-properties"><h2>Instance Properties</h2><h3>Defined in <code class="type">webdriver.promise.Task_</code></h3><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l2072">code »</a><span class="member"><a name="description_">description_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div></summary></details></div></div><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l2075">code »</a><span class="member"><a name="snapshot_">snapshot_</a> : <code class="type">!<a href="class_webdriver_stacktrace_Snapshot.html">webdriver.stacktrace.Snapshot</a></code></span></div></summary></details></div></div><h3>Defined in <code class="type"><a href="class_webdriver_promise_Deferred.html#webdriver.promise.Deferred.<(T|null)>">webdriver.promise.Deferred.<(T|null)></a></code></h3><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l337">code »</a><span class="member"><a name="parent_">parent_</a> : <code class="type"><a href="class_webdriver_promise_Deferred.html">webdriver.promise.Deferred</a></code></span></div><p>The deferred this instance is chained from, if any.</summary></details></div></div><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l564">code »</a><span class="member"><a name="webdriver.promise.Deferred.<(T|null)>.prototype.promise">webdriver.promise.Deferred.<(T|null)>.prototype.promise</a> : <code class="type">webdriver.promise.Promise.<T></code></span></div><p>Represents the eventual value of a completed operation. Each promise may be
|
|
15
15
|
in one of three states: pending, resolved, or rejected. Each promise starts
|
|
16
16
|
in the pending state and may make a single transition to either a
|
|
17
17
|
fulfilled or rejected state, at which point the promise is considered
|
|
18
|
-
resolved.</summary></details></div></div></section><section id="static-properties"><h2>Static Properties</h2><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
18
|
+
resolved.</summary></details></div></div></section><section id="static-properties"><h2>Static Properties</h2><div class="wrap-details public"><div><details><summary><div><a class="source" href="source/lib/webdriver/promise.js.src.html#l2063">code »</a><span class="member"><a name="webdriver.promise.Task_.superClass_">webdriver.promise.Task_.superClass_</a> : <code class="type"><a href="class_webdriver_promise_Deferred.html">webdriver.promise.Deferred.prototype</a></code></span></div></summary></details></div></div></section></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>
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.until.Condition</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Class webdriver.until.Condition.<code class="type"><OUT></code></h1><a class="source" href="source/lib/webdriver/until.js.src.html#l65">code »</a></header><section><p>Defines a condition to<h2>Constructor</h2><div class="ctor wrap-details public"><div><div class="ctor"><span class="member">webdriver.until.Condition <span class="args">( message, fn )</span></span></div><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>message: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dd>A descriptive error message. Should complete the
|
|
2
|
+
sentence "Waiting [...]"<dt>fn: <code class="type">function(!<a href="class_webdriver_WebDriver.html">webdriver.WebDriver</a>): OUT</code><dd>The condition function to
|
|
3
|
+
evaluate on each iteration of the wait loop.</dl></table></div></div></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="instance-methods"><h2>Instance Methods</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/until.js.src.html#l75">code »</a><span class="member"><a name="description">description</a> <span class="args">( )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>A description of this condition.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/until.js.src.html#l70">code »</a><span class="member"><a name="fn">fn</a> <span class="args">( )</span> ⇒ <code class="type">OUT</code></span></div></summary></details></div></div></section><section id="instance-properties"><h2>Instance Properties</h2><div class="wrap-details private"><div><details><summary><div><a class="source" href="source/lib/webdriver/until.js.src.html#l67">code »</a><span class="member"><a name="description_">description_</a> : <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div></summary></details></div></div></section></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,6 +1,6 @@
|
|
|
1
1
|
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.Key</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Enum webdriver.Key</h1><a class="source" href="source/lib/webdriver/key.js.src.html#l25">code »</a><dl><dt>Type: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dl></header><section><p>Representations of pressable keys that aren't text. These are stored in
|
|
2
2
|
the Unicode PUA (Private Use Area) code points, 0xE000-0xF8FF. Refer to
|
|
3
|
-
http://www.google.com.au/search?&q=unicode+pua&btnG=Search<h2>Values and Descriptions</h2><div class="type-summary"><dl class="public"><dt><a class="enum member" name="webdriver.Key.ADD">ADD</a><dt><a class="enum member" name="webdriver.Key.ALT">ALT</a><dt><a class="enum member" name="webdriver.Key.ARROW_DOWN">ARROW_DOWN</a><dt><a class="enum member" name="webdriver.Key.ARROW_LEFT">ARROW_LEFT</a><dt><a class="enum member" name="webdriver.Key.ARROW_RIGHT">ARROW_RIGHT</a><dt><a class="enum member" name="webdriver.Key.ARROW_UP">ARROW_UP</a><dt><a class="enum member" name="webdriver.Key.BACK_SPACE">BACK_SPACE</a><dt><a class="enum member" name="webdriver.Key.CANCEL">CANCEL</a><dt><a class="enum member" name="webdriver.Key.CLEAR">CLEAR</a><dt><a class="enum member" name="webdriver.Key.COMMAND">COMMAND</a><dt><a class="enum member" name="webdriver.Key.CONTROL">CONTROL</a><dt><a class="enum member" name="webdriver.Key.DECIMAL">DECIMAL</a><dt><a class="enum member" name="webdriver.Key.DELETE">DELETE</a><dt><a class="enum member" name="webdriver.Key.DIVIDE">DIVIDE</a><dt><a class="enum member" name="webdriver.Key.DOWN">DOWN</a><dt><a class="enum member" name="webdriver.Key.END">END</a><dt><a class="enum member" name="webdriver.Key.ENTER">ENTER</a><dt><a class="enum member" name="webdriver.Key.EQUALS">EQUALS</a><dt><a class="enum member" name="webdriver.Key.ESCAPE">ESCAPE</a><dt><a class="enum member" name="webdriver.Key.F1">F1</a><dt><a class="enum member" name="webdriver.Key.F10">F10</a><dt><a class="enum member" name="webdriver.Key.F11">F11</a><dt><a class="enum member" name="webdriver.Key.F12">F12</a><dt><a class="enum member" name="webdriver.Key.F2">F2</a><dt><a class="enum member" name="webdriver.Key.F3">F3</a><dt><a class="enum member" name="webdriver.Key.F4">F4</a><dt><a class="enum member" name="webdriver.Key.F5">F5</a><dt><a class="enum member" name="webdriver.Key.F6">F6</a><dt><a class="enum member" name="webdriver.Key.F7">F7</a><dt><a class="enum member" name="webdriver.Key.F8">F8</a><dt><a class="enum member" name="webdriver.Key.F9">F9</a><dt><a class="enum member" name="webdriver.Key.HELP">HELP</a><dt><a class="enum member" name="webdriver.Key.HOME">HOME</a><dt><a class="enum member" name="webdriver.Key.INSERT">INSERT</a><dt><a class="enum member" name="webdriver.Key.LEFT">LEFT</a><dt><a class="enum member" name="webdriver.Key.META">META</a><dt><a class="enum member" name="webdriver.Key.MULTIPLY">MULTIPLY</a><dt><a class="enum member" name="webdriver.Key.NULL">NULL</a><dt><a class="enum member" name="webdriver.Key.NUMPAD0">NUMPAD0</a><dt><a class="enum member" name="webdriver.Key.NUMPAD1">NUMPAD1</a><dt><a class="enum member" name="webdriver.Key.NUMPAD2">NUMPAD2</a><dt><a class="enum member" name="webdriver.Key.NUMPAD3">NUMPAD3</a><dt><a class="enum member" name="webdriver.Key.NUMPAD4">NUMPAD4</a><dt><a class="enum member" name="webdriver.Key.NUMPAD5">NUMPAD5</a><dt><a class="enum member" name="webdriver.Key.NUMPAD6">NUMPAD6</a><dt><a class="enum member" name="webdriver.Key.NUMPAD7">NUMPAD7</a><dt><a class="enum member" name="webdriver.Key.NUMPAD8">NUMPAD8</a><dt><a class="enum member" name="webdriver.Key.NUMPAD9">NUMPAD9</a><dt><a class="enum member" name="webdriver.Key.PAGE_DOWN">PAGE_DOWN</a><dt><a class="enum member" name="webdriver.Key.PAGE_UP">PAGE_UP</a><dt><a class="enum member" name="webdriver.Key.PAUSE">PAUSE</a><dt><a class="enum member" name="webdriver.Key.RETURN">RETURN</a><dt><a class="enum member" name="webdriver.Key.RIGHT">RIGHT</a><dt><a class="enum member" name="webdriver.Key.SEMICOLON">SEMICOLON</a><dt><a class="enum member" name="webdriver.Key.SEPARATOR">SEPARATOR</a><dt><a class="enum member" name="webdriver.Key.SHIFT">SHIFT</a><dt><a class="enum member" name="webdriver.Key.SPACE">SPACE</a><dt><a class="enum member" name="webdriver.Key.SUBTRACT">SUBTRACT</a><dt><a class="enum member" name="webdriver.Key.TAB">TAB</a><dt><a class="enum member" name="webdriver.Key.UP">UP</a></dl></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="static-functions"><h2>Global Functions</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/webdriver.js.src.html#
|
|
3
|
+
http://www.google.com.au/search?&q=unicode+pua&btnG=Search<h2>Values and Descriptions</h2><div class="type-summary"><dl class="public"><dt><a class="enum member" name="webdriver.Key.ADD">ADD</a><dt><a class="enum member" name="webdriver.Key.ALT">ALT</a><dt><a class="enum member" name="webdriver.Key.ARROW_DOWN">ARROW_DOWN</a><dt><a class="enum member" name="webdriver.Key.ARROW_LEFT">ARROW_LEFT</a><dt><a class="enum member" name="webdriver.Key.ARROW_RIGHT">ARROW_RIGHT</a><dt><a class="enum member" name="webdriver.Key.ARROW_UP">ARROW_UP</a><dt><a class="enum member" name="webdriver.Key.BACK_SPACE">BACK_SPACE</a><dt><a class="enum member" name="webdriver.Key.CANCEL">CANCEL</a><dt><a class="enum member" name="webdriver.Key.CLEAR">CLEAR</a><dt><a class="enum member" name="webdriver.Key.COMMAND">COMMAND</a><dt><a class="enum member" name="webdriver.Key.CONTROL">CONTROL</a><dt><a class="enum member" name="webdriver.Key.DECIMAL">DECIMAL</a><dt><a class="enum member" name="webdriver.Key.DELETE">DELETE</a><dt><a class="enum member" name="webdriver.Key.DIVIDE">DIVIDE</a><dt><a class="enum member" name="webdriver.Key.DOWN">DOWN</a><dt><a class="enum member" name="webdriver.Key.END">END</a><dt><a class="enum member" name="webdriver.Key.ENTER">ENTER</a><dt><a class="enum member" name="webdriver.Key.EQUALS">EQUALS</a><dt><a class="enum member" name="webdriver.Key.ESCAPE">ESCAPE</a><dt><a class="enum member" name="webdriver.Key.F1">F1</a><dt><a class="enum member" name="webdriver.Key.F10">F10</a><dt><a class="enum member" name="webdriver.Key.F11">F11</a><dt><a class="enum member" name="webdriver.Key.F12">F12</a><dt><a class="enum member" name="webdriver.Key.F2">F2</a><dt><a class="enum member" name="webdriver.Key.F3">F3</a><dt><a class="enum member" name="webdriver.Key.F4">F4</a><dt><a class="enum member" name="webdriver.Key.F5">F5</a><dt><a class="enum member" name="webdriver.Key.F6">F6</a><dt><a class="enum member" name="webdriver.Key.F7">F7</a><dt><a class="enum member" name="webdriver.Key.F8">F8</a><dt><a class="enum member" name="webdriver.Key.F9">F9</a><dt><a class="enum member" name="webdriver.Key.HELP">HELP</a><dt><a class="enum member" name="webdriver.Key.HOME">HOME</a><dt><a class="enum member" name="webdriver.Key.INSERT">INSERT</a><dt><a class="enum member" name="webdriver.Key.LEFT">LEFT</a><dt><a class="enum member" name="webdriver.Key.META">META</a><dt><a class="enum member" name="webdriver.Key.MULTIPLY">MULTIPLY</a><dt><a class="enum member" name="webdriver.Key.NULL">NULL</a><dt><a class="enum member" name="webdriver.Key.NUMPAD0">NUMPAD0</a><dt><a class="enum member" name="webdriver.Key.NUMPAD1">NUMPAD1</a><dt><a class="enum member" name="webdriver.Key.NUMPAD2">NUMPAD2</a><dt><a class="enum member" name="webdriver.Key.NUMPAD3">NUMPAD3</a><dt><a class="enum member" name="webdriver.Key.NUMPAD4">NUMPAD4</a><dt><a class="enum member" name="webdriver.Key.NUMPAD5">NUMPAD5</a><dt><a class="enum member" name="webdriver.Key.NUMPAD6">NUMPAD6</a><dt><a class="enum member" name="webdriver.Key.NUMPAD7">NUMPAD7</a><dt><a class="enum member" name="webdriver.Key.NUMPAD8">NUMPAD8</a><dt><a class="enum member" name="webdriver.Key.NUMPAD9">NUMPAD9</a><dt><a class="enum member" name="webdriver.Key.PAGE_DOWN">PAGE_DOWN</a><dt><a class="enum member" name="webdriver.Key.PAGE_UP">PAGE_UP</a><dt><a class="enum member" name="webdriver.Key.PAUSE">PAUSE</a><dt><a class="enum member" name="webdriver.Key.RETURN">RETURN</a><dt><a class="enum member" name="webdriver.Key.RIGHT">RIGHT</a><dt><a class="enum member" name="webdriver.Key.SEMICOLON">SEMICOLON</a><dt><a class="enum member" name="webdriver.Key.SEPARATOR">SEPARATOR</a><dt><a class="enum member" name="webdriver.Key.SHIFT">SHIFT</a><dt><a class="enum member" name="webdriver.Key.SPACE">SPACE</a><dt><a class="enum member" name="webdriver.Key.SUBTRACT">SUBTRACT</a><dt><a class="enum member" name="webdriver.Key.TAB">TAB</a><dt><a class="enum member" name="webdriver.Key.UP">UP</a></dl></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="static-functions"><h2>Global Functions</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/webdriver/webdriver.js.src.html#l1588">code »</a><span class="member"><a name="webdriver.Key.chord">webdriver.Key.chord</a> <span class="args">( var_args )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></span></div><p>Simulate pressing many keys at once in a "chord". Takes a sequence of
|
|
4
4
|
<code class="type"><a href="enum_webdriver_Key.html">webdriver.Key</a></code>s or strings, appends each of the values to a string,
|
|
5
5
|
and adds the chord termination key (<code class="type"><a href="enum_webdriver_Key.html#webdriver.Key.NULL">webdriver.Key.NULL</a></code>) and returns
|
|
6
6
|
the resultant string.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.promise.ControlFlow.EventType</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Enum webdriver.promise.ControlFlow.EventType</h1><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
1
|
+
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.promise.ControlFlow.EventType</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Enum webdriver.promise.ControlFlow.EventType</h1><a class="source" href="source/lib/webdriver/promise.js.src.html#l1179">code »</a><dl><dt>Type: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dl></header><section><p>Events that may be emitted by an <code class="type"><a href="class_webdriver_promise_ControlFlow.html">webdriver.promise.ControlFlow</a></code>.<h2>Values and Descriptions</h2><div class="type-summary"><dl class="public"><dt><a class="enum member" name="webdriver.promise.ControlFlow.EventType.IDLE">IDLE</a><dd>Emitted when all tasks have been successfully executed.<dt><a class="enum member" name="webdriver.promise.ControlFlow.EventType.RESET">RESET</a><dd>Emitted when a ControlFlow has been reset.<dt><a class="enum member" name="webdriver.promise.ControlFlow.EventType.SCHEDULE_TASK">SCHEDULE_TASK</a><dd>Emitted whenever a new task has been scheduled.<dt><a class="enum member" name="webdriver.promise.ControlFlow.EventType.UNCAUGHT_EXCEPTION">UNCAUGHT_EXCEPTION</a><dd>Emitted whenever a control flow aborts due to an unhandled promise
|
|
2
2
|
rejection. This event will be emitted along with the offending rejection
|
|
3
3
|
reason. Upon emitting this event, the control flow will empty its task
|
|
4
4
|
queue and revert to its initial state.</dl></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div></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 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.promise.Deferred.State_</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Enum webdriver.promise.Deferred.State_</h1><a class="source" href="source/lib/webdriver/promise.js.src.html#
|
|
1
|
+
<!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>webdriver.promise.Deferred.State_</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Enum webdriver.promise.Deferred.State_</h1><a class="source" href="source/lib/webdriver/promise.js.src.html#l607">code »</a><dl><dt>Type: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code></dl></header><section><p>The three states a <code class="type"><a href="class_webdriver_promise_Deferred.html">webdriver.promise.Deferred</a></code> object may be in.<h2>Values and Descriptions</h2><div class="type-summary"><dl class="private"><dt><a class="enum member" name="webdriver.promise.Deferred.State_.BLOCKED">BLOCKED</a><dt><a class="enum member" name="webdriver.promise.Deferred.State_.PENDING">PENDING</a><dt><a class="enum member" name="webdriver.promise.Deferred.State_.REJECTED">REJECTED</a><dt><a class="enum member" name="webdriver.promise.Deferred.State_.RESOLVED">RESOLVED</a></dl></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div></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>
|