Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit de94dd4

Browse files
gkalpakgkalpak
committed
style($interval): fix indentation
1 parent a2a8d7e commit de94dd4

File tree

1 file changed

+136
-136
lines changed

1 file changed

+136
-136
lines changed

‎src/ng/interval.js

+136-136
Original file line numberDiff line numberDiff line change
@@ -7,132 +7,132 @@ function $IntervalProvider() {
77
var intervals = {};
88

99

10-
/**
11-
* @ngdoc service
12-
* @name $interval
13-
*
14-
* @description
15-
* AngularJS's wrapper for `window.setInterval`. The `fn` function is executed every `delay`
16-
* milliseconds.
17-
*
18-
* The return value of registering an interval function is a promise. This promise will be
19-
* notified upon each tick of the interval, and will be resolved after `count` iterations, or
20-
* run indefinitely if `count` is not defined. The value of the notification will be the
21-
* number of iterations that have run.
22-
* To cancel an interval, call `$interval.cancel(promise)`.
23-
*
24-
* In tests you can use {@link ngMock.$interval#flush `$interval.flush(millis)`} to
25-
* move forward by `millis` milliseconds and trigger any functions scheduled to run in that
26-
* time.
27-
*
28-
* <div class="alert alert-warning">
29-
* **Note**: Intervals created by this service must be explicitly destroyed when you are finished
30-
* with them. In particular they are not automatically destroyed when a controller's scope or a
31-
* directive's element are destroyed.
32-
* You should take this into consideration and make sure to always cancel the interval at the
33-
* appropriate moment. See the example below for more details on how and when to do this.
34-
* </div>
35-
*
36-
* @param {function()} fn A function that should be called repeatedly. If no additional arguments
37-
* are passed (see below), the function is called with the current iteration count.
38-
* @param {number} delay Number of milliseconds between each function call.
39-
* @param {number=} [count=0] Number of times to repeat. If not set, or 0, will repeat
40-
* indefinitely.
41-
* @param {boolean=} [invokeApply=true] If set to `false` skips model dirty checking, otherwise
42-
* will invoke `fn` within the {@link ng.$rootScope.Scope#$apply $apply} block.
43-
* @param {...*=} Pass additional parameters to the executed function.
44-
* @returns {promise} A promise which will be notified on each iteration. It will resolve once all iterations of the interval complete.
45-
*
46-
* @example
47-
* <example module="intervalExample" name="interval-service">
48-
* <file name="index.html">
49-
* <script>
50-
* angular.module('intervalExample', [])
51-
* .controller('ExampleController', ['$scope', '$interval',
52-
* function($scope, $interval) {
53-
* $scope.format = 'M/d/yy h:mm:ss a';
54-
* $scope.blood_1 = 100;
55-
* $scope.blood_2 = 120;
56-
*
57-
* var stop;
58-
* $scope.fight = function() {
59-
* // Don't start a new fight if we are already fighting
60-
* if ( angular.isDefined(stop) ) return;
61-
*
62-
* stop = $interval(function() {
63-
* if ($scope.blood_1 > 0 && $scope.blood_2 > 0) {
64-
* $scope.blood_1 = $scope.blood_1 - 3;
65-
* $scope.blood_2 = $scope.blood_2 - 4;
66-
* } else {
67-
* $scope.stopFight();
68-
* }
69-
* }, 100);
70-
* };
71-
*
72-
* $scope.stopFight = function() {
73-
* if (angular.isDefined(stop)) {
74-
* $interval.cancel(stop);
75-
* stop = undefined;
76-
* }
77-
* };
78-
*
79-
* $scope.resetFight = function() {
80-
* $scope.blood_1 = 100;
81-
* $scope.blood_2 = 120;
82-
* };
83-
*
84-
* $scope.$on('$destroy', function() {
85-
* // Make sure that the interval is destroyed too
86-
* $scope.stopFight();
87-
* });
88-
* }])
89-
* // Register the 'myCurrentTime' directive factory method.
90-
* // We inject $interval and dateFilter service since the factory method is DI.
91-
* .directive('myCurrentTime', ['$interval', 'dateFilter',
92-
* function($interval, dateFilter) {
93-
* // return the directive link function. (compile function not needed)
94-
* return function(scope, element, attrs) {
95-
* var format, // date format
96-
* stopTime; // so that we can cancel the time updates
97-
*
98-
* // used to update the UI
99-
* function updateTime() {
100-
* element.text(dateFilter(new Date(), format));
101-
* }
102-
*
103-
* // watch the expression, and update the UI on change.
104-
* scope.$watch(attrs.myCurrentTime, function(value) {
105-
* format = value;
106-
* updateTime();
107-
* });
108-
*
109-
* stopTime = $interval(updateTime, 1000);
110-
*
111-
* // listen on DOM destroy (removal) event, and cancel the next UI update
112-
* // to prevent updating time after the DOM element was removed.
113-
* element.on('$destroy', function() {
114-
* $interval.cancel(stopTime);
115-
* });
116-
* }
117-
* }]);
118-
* </script>
119-
*
120-
* <div>
121-
* <div ng-controller="ExampleController">
122-
* <label>Date format: <input ng-model="format"></label> <hr/>
123-
* Current time is: <span my-current-time="format"></span>
124-
* <hr/>
125-
* Blood 1 : <font color='red'>{{blood_1}}</font>
126-
* Blood 2 : <font color='red'>{{blood_2}}</font>
127-
* <button type="button" data-ng-click="fight()">Fight</button>
128-
* <button type="button" data-ng-click="stopFight()">StopFight</button>
129-
* <button type="button" data-ng-click="resetFight()">resetFight</button>
130-
* </div>
131-
* </div>
132-
*
133-
* </file>
134-
* </example>
135-
*/
10+
/**
11+
* @ngdoc service
12+
* @name $interval
13+
*
14+
* @description
15+
* AngularJS's wrapper for `window.setInterval`. The `fn` function is executed every `delay`
16+
* milliseconds.
17+
*
18+
* The return value of registering an interval function is a promise. This promise will be
19+
* notified upon each tick of the interval, and will be resolved after `count` iterations, or
20+
* run indefinitely if `count` is not defined. The value of the notification will be the
21+
* number of iterations that have run.
22+
* To cancel an interval, call `$interval.cancel(promise)`.
23+
*
24+
* In tests you can use {@link ngMock.$interval#flush `$interval.flush(millis)`} to
25+
* move forward by `millis` milliseconds and trigger any functions scheduled to run in that
26+
* time.
27+
*
28+
* <div class="alert alert-warning">
29+
* **Note**: Intervals created by this service must be explicitly destroyed when you are finished
30+
* with them. In particular they are not automatically destroyed when a controller's scope or a
31+
* directive's element are destroyed.
32+
* You should take this into consideration and make sure to always cancel the interval at the
33+
* appropriate moment. See the example below for more details on how and when to do this.
34+
* </div>
35+
*
36+
* @param {function()} fn A function that should be called repeatedly. If no additional arguments
37+
* are passed (see below), the function is called with the current iteration count.
38+
* @param {number} delay Number of milliseconds between each function call.
39+
* @param {number=} [count=0] Number of times to repeat. If not set, or 0, will repeat
40+
* indefinitely.
41+
* @param {boolean=} [invokeApply=true] If set to `false` skips model dirty checking, otherwise
42+
* will invoke `fn` within the {@link ng.$rootScope.Scope#$apply $apply} block.
43+
* @param {...*=} Pass additional parameters to the executed function.
44+
* @returns {promise} A promise which will be notified on each iteration. It will resolve once all iterations of the interval complete.
45+
*
46+
* @example
47+
* <example module="intervalExample" name="interval-service">
48+
* <file name="index.html">
49+
* <script>
50+
* angular.module('intervalExample', [])
51+
* .controller('ExampleController', ['$scope', '$interval',
52+
* function($scope, $interval) {
53+
* $scope.format = 'M/d/yy h:mm:ss a';
54+
* $scope.blood_1 = 100;
55+
* $scope.blood_2 = 120;
56+
*
57+
* var stop;
58+
* $scope.fight = function() {
59+
* // Don't start a new fight if we are already fighting
60+
* if ( angular.isDefined(stop) ) return;
61+
*
62+
* stop = $interval(function() {
63+
* if ($scope.blood_1 > 0 && $scope.blood_2 > 0) {
64+
* $scope.blood_1 = $scope.blood_1 - 3;
65+
* $scope.blood_2 = $scope.blood_2 - 4;
66+
* } else {
67+
* $scope.stopFight();
68+
* }
69+
* }, 100);
70+
* };
71+
*
72+
* $scope.stopFight = function() {
73+
* if (angular.isDefined(stop)) {
74+
* $interval.cancel(stop);
75+
* stop = undefined;
76+
* }
77+
* };
78+
*
79+
* $scope.resetFight = function() {
80+
* $scope.blood_1 = 100;
81+
* $scope.blood_2 = 120;
82+
* };
83+
*
84+
* $scope.$on('$destroy', function() {
85+
* // Make sure that the interval is destroyed too
86+
* $scope.stopFight();
87+
* });
88+
* }])
89+
* // Register the 'myCurrentTime' directive factory method.
90+
* // We inject $interval and dateFilter service since the factory method is DI.
91+
* .directive('myCurrentTime', ['$interval', 'dateFilter',
92+
* function($interval, dateFilter) {
93+
* // return the directive link function. (compile function not needed)
94+
* return function(scope, element, attrs) {
95+
* var format, // date format
96+
* stopTime; // so that we can cancel the time updates
97+
*
98+
* // used to update the UI
99+
* function updateTime() {
100+
* element.text(dateFilter(new Date(), format));
101+
* }
102+
*
103+
* // watch the expression, and update the UI on change.
104+
* scope.$watch(attrs.myCurrentTime, function(value) {
105+
* format = value;
106+
* updateTime();
107+
* });
108+
*
109+
* stopTime = $interval(updateTime, 1000);
110+
*
111+
* // listen on DOM destroy (removal) event, and cancel the next UI update
112+
* // to prevent updating time after the DOM element was removed.
113+
* element.on('$destroy', function() {
114+
* $interval.cancel(stopTime);
115+
* });
116+
* }
117+
* }]);
118+
* </script>
119+
*
120+
* <div>
121+
* <div ng-controller="ExampleController">
122+
* <label>Date format: <input ng-model="format"></label> <hr/>
123+
* Current time is: <span my-current-time="format"></span>
124+
* <hr/>
125+
* Blood 1 : <font color='red'>{{blood_1}}</font>
126+
* Blood 2 : <font color='red'>{{blood_2}}</font>
127+
* <button type="button" data-ng-click="fight()">Fight</button>
128+
* <button type="button" data-ng-click="stopFight()">StopFight</button>
129+
* <button type="button" data-ng-click="resetFight()">resetFight</button>
130+
* </div>
131+
* </div>
132+
*
133+
* </file>
134+
* </example>
135+
*/
136136
function interval(fn, delay, count, invokeApply) {
137137
var hasParams = arguments.length > 4,
138138
args = hasParams ? sliceArgs(arguments, 4) : [],
@@ -177,16 +177,16 @@ function $IntervalProvider() {
177177
}
178178

179179

180-
/**
181-
* @ngdoc method
182-
* @name $interval#cancel
183-
*
184-
* @description
185-
* Cancels a task associated with the `promise`.
186-
*
187-
* @param {Promise=} promise returned by the `$interval` function.
188-
* @returns {boolean} Returns `true` if the task was successfully canceled.
189-
*/
180+
/**
181+
* @ngdoc method
182+
* @name $interval#cancel
183+
*
184+
* @description
185+
* Cancels a task associated with the `promise`.
186+
*
187+
* @param {Promise=} promise returned by the `$interval` function.
188+
* @returns {boolean} Returns `true` if the task was successfully canceled.
189+
*/
190190
interval.cancel = function(promise) {
191191
if (promise && promise.$$intervalId in intervals) {
192192
// Interval cancels should not report as unhandled promise.

0 commit comments

Comments
 (0)