summaryrefslogtreecommitdiff
path: root/api/jsapi.txt
diff options
context:
space:
mode:
authorportix <none@none>2012-12-08 04:40:36 +0100
committerportix <none@none>2012-12-08 04:40:36 +0100
commitf7c1c5ebe3ff5a755cd8025635da05ac7807db8c (patch)
tree34f7e31949628e9e479c79c85147fc36eb053481 /api/jsapi.txt
parent89e9043503133bc4a89cc169bf328bc6732eb330 (diff)
downloaddwb-f7c1c5ebe3ff5a755cd8025635da05ac7807db8c.zip
Updated js-api
Diffstat (limited to 'api/jsapi.txt')
-rw-r--r--api/jsapi.txt9
1 files changed, 6 insertions, 3 deletions
diff --git a/api/jsapi.txt b/api/jsapi.txt
index cb411b95..c466f3c5 100644
--- a/api/jsapi.txt
+++ b/api/jsapi.txt
@@ -1066,7 +1066,7 @@ Deferreds implement the following methods:
[source,javascript]
----
-void Deferred.done(Function callback)
+Deferred Deferred.done(Function callback)
----
Registers a function for the done-chain.
@@ -1076,6 +1076,7 @@ Registers a function for the done-chain.
_callback_;; A callback function that will be called when the Deferred is
resolved. If the function returns a deferred the original deferred will be replaced with
the new deferred.
+_returns_;; A new deferred that can be used to chain callbacks.
****
****
@@ -1094,6 +1095,7 @@ Registers a function for the fail-chain.
_callback_;; A callback function that will be called when the deferred is
rejected. If the function returns a deferred the original deferred will be replaced with
the new deferred.
+_returns_;; A new deferred that can be used to chain callbacks.
****
****
@@ -1118,7 +1120,7 @@ _arguments_;; Arguments passed to the _fail_ callbacks.
[source,javascript]
----
-void Deferred.resolve(arguments)
+Deferred Deferred.resolve(arguments)
----
Resolves a deferred, the done-chain is called when a deferred is resolved.
@@ -1134,7 +1136,7 @@ _arguments_;; Arguments passed to the _done_ callbacks.
[source,javascript]
----
-void Deferred.then(Function ondone, Function onfail)
+Deferred Deferred.then(Function ondone, Function onfail)
----
Registers a function for the done and fail chain.
@@ -1147,6 +1149,7 @@ the new deferred.
_onfail_;; A callback function that will be called when the deferred is
rejected. If the function returns a deferred the original deferred will be replaced with
the new deferred.
+_returns_;; A new deferred that can be used to chain callbacks.
****
==== *Examples* ====