diff options
author | portix <none@none> | 2012-12-08 04:40:36 +0100 |
---|---|---|
committer | portix <none@none> | 2012-12-08 04:40:36 +0100 |
commit | f7c1c5ebe3ff5a755cd8025635da05ac7807db8c (patch) | |
tree | 34f7e31949628e9e479c79c85147fc36eb053481 /api | |
parent | 89e9043503133bc4a89cc169bf328bc6732eb330 (diff) | |
download | dwb-f7c1c5ebe3ff5a755cd8025635da05ac7807db8c.zip |
Updated js-api
Diffstat (limited to 'api')
-rw-r--r-- | api/dwb-js.7 | 21 | ||||
-rw-r--r-- | api/jsapi.7.txt | 9 | ||||
-rw-r--r-- | api/jsapi.txt | 9 |
3 files changed, 30 insertions, 9 deletions
diff --git a/api/dwb-js.7 b/api/dwb-js.7 index b3cc9a31..3db3dce2 100644 --- a/api/dwb-js.7 +++ b/api/dwb-js.7 @@ -1155,6 +1155,11 @@ Registers a function for the done\-chain\&. .RS 4 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\&. .RE +.PP +\fIreturns\fR +.RS 4 +A new deferred that can be used to chain callbacks\&. +.RE .RE .sp .it 1 an-trap @@ -1162,7 +1167,7 @@ A callback function that will be called when the Deferred is resolved\&. If the .nr an-break-flag 1 .br .ps +1 -\fBvoid Deferred.fail(Function callback)\fR +\fBDeferred Deferred.fail(Function callback)\fR .RS 4 .sp Registers a function for the fail\-chain\&. @@ -1171,6 +1176,11 @@ Registers a function for the fail\-chain\&. .RS 4 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\&. .RE +.PP +\fIreturns\fR +.RS 4 +A new deferred that can be used to chain callbacks\&. +.RE .RE .sp .it 1 an-trap @@ -1178,7 +1188,7 @@ A callback function that will be called when the deferred is rejected\&. If the .nr an-break-flag 1 .br .ps +1 -\fBvoid Deferred.reject(arguments)\fR +\fBDeferred Deferred.reject(arguments)\fR .RS 4 .sp Rejects a deferred, the fail\-chain is called when a deferred is rejected\&. @@ -1214,7 +1224,7 @@ callbacks\&. .nr an-break-flag 1 .br .ps +1 -\fBvoid Deferred.then(Function ondone, Function onfail)\fR +\fBDeferred Deferred.then(Function ondone, Function onfail)\fR .RS 4 .sp Registers a function for the done and fail chain\&. @@ -1228,6 +1238,11 @@ A callback function that will be called when the deferred is resolved\&. If the .RS 4 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\&. .RE +.PP +\fIreturns\fR +.RS 4 +A new deferred that can be used to chain callbacks\&. +.RE .sp Simple usage of a deferred: .sp diff --git a/api/jsapi.7.txt b/api/jsapi.7.txt index a0d223d4..5680a109 100644 --- a/api/jsapi.7.txt +++ b/api/jsapi.7.txt @@ -535,9 +535,10 @@ 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. **** -==== void Deferred.fail(Function callback) +==== Deferred Deferred.fail(Function callback) **** Registers a function for the fail-chain. @@ -545,9 +546,10 @@ 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. **** -==== void Deferred.reject(arguments) +==== Deferred Deferred.reject(arguments) **** Rejects a deferred, the fail-chain is called when a deferred is rejected. @@ -563,7 +565,7 @@ Resolves a deferred, the done-chain is called when a deferred is resolved. _arguments_;; Arguments passed to the _done_ callbacks. **** -==== void Deferred.then(Function ondone, Function onfail) +==== Deferred Deferred.then(Function ondone, Function onfail) **** Registers a function for the done and fail chain. @@ -574,6 +576,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. **** 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* ==== |