WindowOrWorkerGlobalScope.clearTimeout()

clearTimeout() метод WindowOrWorkerGlobalScope отменяет таймаут, ранее установленный вызовом setTimeout().

Синтаксис

scope.clearTimeout(timeoutID)

Параметры

timeoutID
Идентификатор таймаута, который вы хотите отменить. Этот идентификатор был возвращён соответствующим вызовом setTimeout().

It's worth noting that the pool of IDs used by setTimeout() and setInterval() are shared, which means you can technically use clearTimeout() and clearInterval() (en-US) interchangeably. However, for clarity, you should avoid doing so.

Пример использования:

Запустите приведённый ниже скрипт в контакте веб-страницы и кликните один раз. Вы увидите всплывающее сообщение через 1 секунду. Если вы щёлкните страницу несколько раз за одну секунду, предупреждение появится только один раз.

var alarm = {
  remind: function(aMessage) {
    alert(aMessage);
    this.timeoutID = undefined;
  },

  setup: function() {
    if (typeof this.timeoutID === 'number') {
      this.cancel();
    }

    this.timeoutID = window.setTimeout(function(msg) {
      this.remind(msg);
    }.bind(this), 1000, 'Wake up!');
  },

  cancel: function() {
    window.clearTimeout(this.timeoutID);
  }
};
window.onclick = function() { alarm.setup(); };

Примечания

Передача недействительного ID clearTimeout() ни к чему не приведёт. Исключение не создается.

Спецификация

Specification Status Comment
HTML Living Standard
Определение 'WindowOrWorkerGlobalScope.clearTimeout()' в этой спецификации.
Живой стандарт Method moved to the WindowOrWorkerGlobalScope mixin in the latest spec.
HTML Living Standard
Определение 'clearTimeout()' в этой спецификации.
Живой стандарт

Совместимость с браузером

No compatibility data found for api.WindowOrWorkerGlobalScope.clearTimeout.
Check for problems with this page or contribute missing data to mdn/browser-compat-data.

Смотрите также