Skip to content

Commit

Permalink
deferred.resolve(): Add note about promise
Browse files Browse the repository at this point in the history
Make consistent with other methods like:
* `resolveWith`
* `notify`, `notifyWith`
* `reject`, `rejectWith`

Closes gh-681
  • Loading branch information
evverx authored and arthurvr committed Mar 26, 2015
1 parent aa3573d commit 900c3ce
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions entries/deferred.resolve.xml
Expand Up @@ -11,6 +11,7 @@
</signature>
<desc> Resolve a Deferred object and call any doneCallbacks with the given <code>args</code>. </desc>
<longdesc>
<p>Normally, only the creator of a Deferred should call this method; you can prevent other code from changing the Deferred's state by returning a restricted Promise object through <a href="/deferred.promise/"><code>deferred.promise()</code></a>.</p>
<p>When the Deferred is resolved, any doneCallbacks added by <a href="/deferred.then/"><code>deferred.then()</code></a> or <a href="/deferred.done/"><code>deferred.done()</code></a> are called. Callbacks are executed in the order they were added. Each callback is passed the <code>args</code> from the <code>deferred.resolve()</code>. Any doneCallbacks added after the Deferred enters the resolved state are executed immediately when they are added, using the arguments that were passed to the <code>deferred.resolve()</code> call. For more information, see the documentation for <a href="/jQuery.Deferred/">jQuery.Deferred()</a>.</p>
</longdesc>
<category slug="deferred-object"/>
Expand Down

0 comments on commit 900c3ce

Please sign in to comment.