Credit to devdocs.io

angularjs 1.4

angularjs

Improve this Doc View Source $interval

  1. service in module ngMock

Mock implementation of the $interval service.

Use $interval.flush(millis) to move forward by millis milliseconds and trigger any functions scheduled to run in that time.

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 promise

    A promise from calling the $interval function.

    Returns

    boolean

    Returns true if the task was successfully cancelled.

  • flush([millis]);

    Runs interval tasks scheduled to be run in the next millis milliseconds.

    Parameters

    Param Type Details
    millis
    (optional)
    number

    maximum timeout amount to flush up until.

    Returns

    number

    The amount of time moved forward.

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