| <!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#l76">code »</a></header><section><p>Represents the eventual value of a completed operation. Each promise may be | |
| in one of three states: pending, resolved, or rejected. Each promise starts | |
| in the pending state and may make a single transition to either a | |
| fulfilled or failed state. | |
| <p/>This class is based on the Promise/A proposal from CommonJS. Additional | |
| functions are provided for API compatibility with Dojo Deferred objects.<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#l87">code »</a><span class="member"><a name="cancel">cancel</a> <span class="args">( reason )</span></span></div><p>Cancels the computation of this promise's value, rejecting the promise in the | |
| process.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>reason: <code class="type">*</code><dd>The reason this promise is being cancelled. If not an | |
| <code >Error</code>, one will be created using the value's string | |
| representation.</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#l93">code »</a><span class="member"><a name="isPending">isPending</a> <span class="args">( )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div></summary><div class="info"><table><tbody><tr><th>Returns<tr><td><dl>Whether this promise's value is still being computed.</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#l112">code »</a><code class="type"><R></code> <span class="member"><a name="then">then</a> <span class="args">( opt_callback, opt_errback )</span> ⇒ <code class="type">!<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>.<R></code></span></div><p>Registers listeners for when this instance is resolved. This function most | |
| overridden by subtypes.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>opt_callback: <code class="type">?(function(T): (R|<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>.<R>))=</code><dd>The | |
| function to call if this promise is successfully resolved. The function | |
| should expect a single argument: the promise's resolved value.<dt>opt_errback: <code class="type">?(function(*): (R|<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>.<R>))=</code><dd>The | |
| function to call if this promise is rejected. The function should expect | |
| a single argument: the rejection reason.</dl><tr><th>Returns<tr><td><dl>A new promise which will be | |
| resolved with the result of the invoked callback.</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#l142">code »</a><code class="type"><R></code> <span class="member"><a name="thenCatch">thenCatch</a> <span class="args">( errback )</span> ⇒ <code class="type">!<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>.<R></code></span></div><p>Registers a listener for when this promise is rejected. This is synonymous | |
| with the <code >catch</code> clause in a synchronous API: | |
| <pre><code> | |
| // Synchronous API: | |
| try { | |
| doSynchronousWork(); | |
| } catch (ex) { | |
| console.error(ex); | |
| } | |
| // Asynchronous promise API: | |
| doAsynchronousWork().thenCatch(function(ex) { | |
| console.error(ex); | |
| }); | |
| </code></pre></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>errback: <code class="type">function(*): (R|<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>.<R>)</code><dd>The function | |
| to call if this promise is rejected. The function should expect a single | |
| argument: the rejection reason.</dl><tr><th>Returns<tr><td><dl>A new promise which will be | |
| resolved with the result of the invoked callback.</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#l186">code »</a><code class="type"><R></code> <span class="member"><a name="thenFinally">thenFinally</a> <span class="args">( callback )</span> ⇒ <code class="type">!<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>.<R></code></span></div><p>Registers a listener to invoke when this promise is resolved, regardless | |
| of whether the promise's value was successfully computed. This function | |
| is synonymous with the <code >finally</code> clause in a synchronous API: | |
| <pre><code> | |
| // Synchronous API: | |
| try { | |
| doSynchronousWork(); | |
| } finally { | |
| cleanUp(); | |
| } | |
| // Asynchronous promise API: | |
| doAsynchronousWork().thenFinally(cleanUp); | |
| </code></pre> | |
| <b>Note:</b> similar to the <code >finally</code> clause, if the registered | |
| callback returns a rejected promise or throws an error, it will silently | |
| replace the rejection error (if any) from this promise: | |
| <pre><code> | |
| try { | |
| throw Error('one'); | |
| } finally { | |
| throw Error('two'); // Hides Error: one | |
| } | |
| webdriver.promise.rejected(Error('one')) | |
| .thenFinally(function() { | |
| throw Error('two'); // Hides Error: one | |
| }); | |
| </code></pre></summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>callback: <code class="type">function(): (R|<a href="class_webdriver_promise_Promise.html">webdriver.promise.Promise</a>.<R>)</code><dd>The function | |
| to call when this promise is resolved.</dl><tr><th>Returns<tr><td><dl>A promise that will be fulfilled | |
| with the callback result.</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>No data</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>No data</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>No data</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> |