aboutsummaryrefslogtreecommitdiffstats
path: root/src/Browser.js
diff options
context:
space:
mode:
authorIgor Minar2011-10-21 23:33:24 -0700
committerIgor Minar2011-10-22 21:32:48 -0700
commitad90c3574f8365ee4a1a973d5e43c64fe9fcda2c (patch)
tree19b62a31a7804d4fb7ece4afd6e79d56d7e35ac0 /src/Browser.js
parente28171d5e493e0878d5276a44d4aa3db4ebd74f2 (diff)
downloadangular.js-ad90c3574f8365ee4a1a973d5e43c64fe9fcda2c.tar.bz2
feat($defer): add $defer.cancel
This functionality was previously available only as obscure $browser.defer.cancel. I also added docs and tests and fixed an issue in .defer.cancel mock.
Diffstat (limited to 'src/Browser.js')
-rw-r--r--src/Browser.js5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/Browser.js b/src/Browser.js
index cc5e257b..9045c2b2 100644
--- a/src/Browser.js
+++ b/src/Browser.js
@@ -390,12 +390,13 @@ function Browser(window, document, body, XHR, $log, $sniffer) {
*
* @name angular.service.$browser#defer.cancel
* @methodOf angular.service.$browser.defer
- * @returns {boolean} Returns `true` if the task hasn't executed yet and was successfuly canceled.
*
* @description
* Cancels a defered task identified with `deferId`.
+ *
+ * @param {*} deferId Token returned by the `$browser.defer` function.
+ * @returns {boolean} Returns `true` if the task hasn't executed yet and was successfuly canceled.
*/
-
self.defer.cancel = function(deferId) {
if (pendingDeferIds[deferId]) {
delete pendingDeferIds[deferId];