mirror of
https://github.com/Hopiu/angular.js.git
synced 2026-03-17 15:40:22 +00:00
6b91aa0a18
This change causes a new $digest to be scheduled in the next tick if a task was was sent to the $evalAsync queue from outside of a $digest or an $apply. While this mode of operation is not common for most of the user code, this change means that $q promises that utilze $evalAsync queue to guarantee asynchronicity of promise apis will now also resolve outside of a $digest, which turned out to be a big pain point for some developers. The implementation ensures that we don't do more work than needed and that we coalese as much work as possible into a single $digest. The use of $browser instead of setTimeout ensures that we can mock out and control the scheduling of "auto-flush", which should in theory allow all of the existing code and tests to work without negative side-effects. Closes #3539 Closes #2438
86 lines
2.8 KiB
JavaScript
86 lines
2.8 KiB
JavaScript
'use strict';
|
|
|
|
|
|
function $TimeoutProvider() {
|
|
this.$get = ['$rootScope', '$browser', '$q', '$exceptionHandler',
|
|
function($rootScope, $browser, $q, $exceptionHandler) {
|
|
var deferreds = {};
|
|
|
|
|
|
/**
|
|
* @ngdoc function
|
|
* @name ng.$timeout
|
|
* @requires $browser
|
|
*
|
|
* @description
|
|
* Angular's wrapper for `window.setTimeout`. The `fn` function is wrapped into a try/catch
|
|
* block and delegates any exceptions to
|
|
* {@link ng.$exceptionHandler $exceptionHandler} service.
|
|
*
|
|
* The return value of registering a timeout function is a promise, which will be resolved when
|
|
* the timeout is reached and the timeout function is executed.
|
|
*
|
|
* To cancel a timeout request, call `$timeout.cancel(promise)`.
|
|
*
|
|
* In tests you can use {@link ngMock.$timeout `$timeout.flush()`} to
|
|
* synchronously flush the queue of deferred functions.
|
|
*
|
|
* @param {function()} fn A function, whose execution should be delayed.
|
|
* @param {number=} [delay=0] Delay in milliseconds.
|
|
* @param {boolean=} [invokeApply=true] If set to `false` skips model dirty checking, otherwise
|
|
* will invoke `fn` within the {@link ng.$rootScope.Scope#$apply $apply} block.
|
|
* @returns {Promise} Promise that will be resolved when the timeout is reached. The value this
|
|
* promise will be resolved with is the return value of the `fn` function.
|
|
*/
|
|
function timeout(fn, delay, invokeApply) {
|
|
var deferred = $q.defer(),
|
|
promise = deferred.promise,
|
|
skipApply = (isDefined(invokeApply) && !invokeApply),
|
|
timeoutId;
|
|
|
|
timeoutId = $browser.defer(function() {
|
|
try {
|
|
deferred.resolve(fn());
|
|
} catch(e) {
|
|
deferred.reject(e);
|
|
$exceptionHandler(e);
|
|
}
|
|
finally {
|
|
delete deferreds[promise.$$timeoutId];
|
|
}
|
|
|
|
if (!skipApply) $rootScope.$apply();
|
|
}, delay);
|
|
|
|
promise.$$timeoutId = timeoutId;
|
|
deferreds[timeoutId] = deferred;
|
|
|
|
return promise;
|
|
}
|
|
|
|
|
|
/**
|
|
* @ngdoc function
|
|
* @name ng.$timeout#cancel
|
|
* @methodOf ng.$timeout
|
|
*
|
|
* @description
|
|
* Cancels a task associated with the `promise`. As a result of this, the promise will be
|
|
* resolved with a rejection.
|
|
*
|
|
* @param {Promise=} promise Promise returned by the `$timeout` function.
|
|
* @returns {boolean} Returns `true` if the task hasn't executed yet and was successfully
|
|
* canceled.
|
|
*/
|
|
timeout.cancel = function(promise) {
|
|
if (promise && promise.$$timeoutId in deferreds) {
|
|
deferreds[promise.$$timeoutId].reject('canceled');
|
|
delete deferreds[promise.$$timeoutId];
|
|
return $browser.defer.cancel(promise.$$timeoutId);
|
|
}
|
|
return false;
|
|
};
|
|
|
|
return timeout;
|
|
}];
|
|
}
|