Улучшить документацию Просмотреть исходный код $timeout
- сервис в модуле ng
Обзор
Обёртка AngularJS для window.setTimeout. Функция fn обернута в блок try/catch и делегирует любые исключения сервису $exceptionHandler.
Возвращаемое значение вызова $timeout — это промис, который будет выполнен, когда истечёт задержка и будет выполнена функция таймаута (если она указана).
Чтобы отменить запрос таймаута, вызовите $timeout.cancel(promise).
В тестах можно использовать $timeout.flush() для синхронного сброса очереди отложенных функций.
Если вам нужен только промис, который выполнится через определённую задержку, то можно вызвать $timeout без функции fn.
Использование
$timeout([fn], [delay], [invokeApply], [Pass]);
Аргументы
| Параметр | Тип | Подробности |
|---|---|---|
| fn (необязательно) | function()= | Функция, выполнение которой должно быть отложено. |
| delay (необязательно) | number | Задержка в миллисекундах. (по умолчанию: 0) |
| invokeApply (необязательно) | boolean | Если установлено значение (по умолчанию: true) |
| Pass (необязательно) | * | дополнительные параметры для выполняемой функции. |
Возвращаемое значение
Promise |
Промис, который будет выполнен по достижении таймаута. Промис будет выполнен со значением, возвращённым функцией |
Методы
-
cancel([promise]);
Отменяет задачу, связанную с
promise. В результате промис будет выполнен с отказом.Параметры
Параметр Тип Подробности promise (необязательно)PromiseПромис, возвращённый функцией
$timeout.Возвращаемое значение
booleanВозвращает
trueесли задача ещё не выполнена и была успешно отменена.
© 2010–2018 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://code.angularjs.org/1.6.9/docs/api/ng/service/$timeout