W3cubDocs

/Angular.js 1.4

Improve this Doc View Source $interval

  1. service in module ng

Angular's wrapper for window.setInterval. The fn function is executed every delay milliseconds.

The return value of registering an interval function is a promise. This promise will be notified upon each tick of the interval, and will be resolved after count iterations, or run indefinitely if count is not defined. The value of the notification will be the number of iterations that have run. To cancel an interval, call $interval.cancel(promise).

In tests you can use $interval.flush(millis) to move forward by millis milliseconds and trigger any functions scheduled to run in that time.

Note: Intervals created by this service must be explicitly destroyed when you are finished with them. In particular they are not automatically destroyed when a controller's scope or a directive's element are destroyed. You should take this into consideration and make sure to always cancel the interval at the appropriate moment. See the example below for more details on how and when to do this.

Usage

$interval(fn, delay, [count], [invokeApply], [Pass]);

Arguments

Param Type Details
fn function()

A function that should be called repeatedly.
delay number

Number of milliseconds between each function call.
count
(optional)
 number

Number of times to repeat. If not set, or 0, will repeat indefinitely.

(default: 0)
invokeApply
(optional)
 boolean

If set to false skips model dirty checking, otherwise will invoke fn within the $apply block.

(default: true)
Pass
(optional)
 *

additional parameters to the executed function.

Returns

promise

A promise which will be notified on each iteration.

Methods

  • cancel([promise]);

    Cancels a task associated with the promise.

    Parameters

    Param Type Details
    promise
    (optional)
    		 Promise

    returned by the $interval function.

    Returns

    boolean

    Returns true if the task was successfully canceled.

© 2010–2016 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://code.angularjs.org/1.4.14/docs/api/ng/service/$interval