DOM:window.clearTimeout

From MDC

« Gecko DOM Reference

Contents 1 Summary 2 Syntax 3 Example 4 Notes 5 Specification

[edit] Summary

Clears the delay set by window.setTimeout().

[edit] Syntax

window.clearTimeout(timeoutID)

where timeoutID is the ID of the timeout you wish you clear, as returned by window.setTimeout().

[edit] Example

Run the script below in the context of a web page and click on the page once. You'll see a message popping up in a second. If you keep clicking on the page once in a second, the alert never appears.

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() };

[edit] Notes

Passing an invalid ID to clearTimeout does not have any effect (and doesn't throw an exception).

[edit] Specification

DOM Level 0. Not part of any standard.