Skip to content

Commit d443d96

Browse files
AurelioDeRosagnarf
authored andcommitted
deferred.progress: Accepts multiple arguments
Closes gh-568
1 parent 41fc751 commit d443d96

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

entries/deferred.progress.xml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,17 @@
1010
A function, or array of functions, to be called when the Deferred generates progress notifications.
1111
</desc>
1212
</argument>
13+
<argument name="progressCallbacks">
14+
<type name="Function"/>
15+
<type name="Array"/>
16+
<desc>
17+
Optional additional function, or array of functions, to be called when the Deferred generates progress notifications.
18+
</desc>
19+
</argument>
1320
</signature>
1421
<desc> Add handlers to be called when the Deferred object generates progress notifications.</desc>
1522
<longdesc>
16-
<p>The argument can be either a single function or an array of functions. When the Deferred generates progress notifications by calling <code>notify</code> or <code>notifyWith</code>, the <code>progressCallbacks</code> are called. Since <code>deferred.progress()</code> returns the Deferred object, other methods of the Deferred object can be chained to this one. When the Deferred is resolved or rejected, progress callbacks will no longer be called, with the exception that any <code>progressCallbacks</code> added after the Deferred enters the resolved or rejected state are executed immediately when they are added, using the arguments that were passed to the <code>.notify()</code> or <code>notifyWith()</code> call. For more information, see the documentation for <a href="/jQuery.Deferred/">jQuery.Deferred()</a>.</p>
23+
<p>The <code>deferred.progress()</code> method accepts one or more arguments, all of which can be either a single function or an array of functions. When the Deferred generates progress notifications by calling <code>notify</code> or <code>notifyWith</code>, the <code>progressCallbacks</code> are called. Since <code>deferred.progress()</code> returns the Deferred object, other methods of the Deferred object can be chained to this one. When the Deferred is resolved or rejected, progress callbacks will no longer be called, with the exception that any <code>progressCallbacks</code> added after the Deferred enters the resolved or rejected state are executed immediately when they are added, using the arguments that were passed to the <code>.notify()</code> or <code>notifyWith()</code> call. For more information, see the documentation for <a href="/jQuery.Deferred/">jQuery.Deferred()</a>.</p>
1724
</longdesc>
1825
<category slug="deferred-object"/>
1926
<category slug="version/1.7"/>

0 commit comments

Comments
 (0)