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

docs(interval.js) alerting the developer #5377

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/ng/interval.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ function $IntervalProvider() {
* In tests you can use {@link ngMock.$interval#methods_flush `$interval.flush(millis)`} to
* move forward by `millis` milliseconds and trigger any functions scheduled to run in that
* time.
*
* <div class="alert alert-warning">
* **Note**: The interval craeted by this service is not cleared during the $scope.$destroy() event.
* The developer should take this into consideration and make sure to always cancel the interval
* inside a broadcasted 'destroy' event.
* </div>
*
* @param {function()} fn A function that should be called repeatedly.
* @param {number} delay Number of milliseconds between each function call.
Expand Down