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

Commit 9bffccd

Browse files
MikeMcElroypetebacondarwin
authored andcommitted
docs($interval): cancel() takes a promise not a number
Closes #6485
1 parent 6b18a56 commit 9bffccd

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

src/ng/interval.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ function $IntervalProvider() {
168168
* @description
169169
* Cancels a task associated with the `promise`.
170170
*
171-
* @param {number} promise Promise returned by the `$interval` function.
171+
* @param {promise} promise returned by the `$interval` function.
172172
* @returns {boolean} Returns `true` if the task was successfully canceled.
173173
*/
174174
interval.cancel = function(promise) {

src/ngMock/angular-mocks.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -498,7 +498,7 @@ angular.mock.$IntervalProvider = function() {
498498
* @description
499499
* Cancels a task associated with the `promise`.
500500
*
501-
* @param {number} promise A promise from calling the `$interval` function.
501+
* @param {promise} promise A promise from calling the `$interval` function.
502502
* @returns {boolean} Returns `true` if the task was successfully cancelled.
503503
*/
504504
$interval.cancel = function(promise) {

0 commit comments

Comments
 (0)