WindowTimers.clearTimeout()

Sumário

Remove um timeout criado pela função WindowTimers.setTimeout().

Síntaxe

window.clearTimeout(timeoutID)

• timeoutID é o ID do timeout que você deseja remover. Esse ID é o retorno da função WindowTimers.setTimeout().

Exemplo

Execute o script abaixo em uma página web e clique na página uma vez. Você verá uma mensagem aparecer um segundo depois. Se você continuar clicando na página uma vez por segundo, a mensagem nunca aparecerá.

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

  setup: function() {
    this.cancel();
    var self = this;
    this.timeoutID = window.setTimeout(function(msg) {self.remind(msg);}, 1000, "Wake up!");
  },

  cancel: function() {
    if(typeof this.timeoutID == "number") {
      window.clearTimeout(this.timeoutID);
      delete this.timeoutID;
    }
  }
};
window.onclick = function() { alarm.setup() };

Notas

Passar um ID inválido para clearTimeout não causa nenhum efeito (e não lança nenhuma exceção).

Especificação

Especificado no HTML5.

Veja também

• WindowTimers.setTimeout()
• WindowTimers.setInterval()
• WindowTimers.clearInterval()
• Window.requestAnimationFrame()
• Daemons management