From ad90c3574f8365ee4a1a973d5e43c64fe9fcda2c Mon Sep 17 00:00:00 2001
From: Igor Minar
Date: Fri, 21 Oct 2011 23:33:24 -0700
Subject: 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.
---
 src/Browser.js       |  5 +++--
 src/angular-mocks.js |  1 +
 src/service/defer.js | 24 ++++++++++++++++++++++--
 3 files changed, 26 insertions(+), 4 deletions(-)

(limited to 'src')

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];
diff --git a/src/angular-mocks.js b/src/angular-mocks.js
index e9b01c40..aabbf9ce 100644
--- a/src/angular-mocks.js
+++ b/src/angular-mocks.js
@@ -283,6 +283,7 @@ function MockBrowser() {
 
     if (fnIndex !== undefined) {
       self.deferredFns.splice(fnIndex, 1);
+      return true;
     }
   };
 
diff --git a/src/service/defer.js b/src/service/defer.js
index 7d0fdeb7..42f80d25 100644
--- a/src/service/defer.js
+++ b/src/service/defer.js
@@ -14,12 +14,32 @@
  *
  * @param {function()} fn A function, who's execution should be deferred.
  * @param {number=} [delay=0] of milliseconds to defer the function execution.
+ * @returns {*} DeferId that can be used to cancel the task via `$defer.cancel()`.
+ */
+
+/**
+ * @ngdoc function
+ * @name angular.service.$defer#cancel
+ * @methodOf angular.service.$defer
+ *
+ * @description
+ * Cancels a defered task identified with `deferId`.
+ *
+ * @param {*} deferId Token returned by the `$defer` function.
+ * @returns {boolean} Returns `true` if the task hasn't executed yet and was successfuly canceled.
  */
 angularServiceInject('$defer', function($browser) {
   var scope = this;
-  return function(fn, delay) {
-    $browser.defer(function() {
+
+  function defer(fn, delay) {
+    return $browser.defer(function() {
       scope.$apply(fn);
     }, delay);
+  }
+
+  defer.cancel = function(deferId) {
+    return $browser.defer.cancel(deferId);
   };
+
+  return defer;
 }, ['$browser']);
-- 
cgit v1.2.3