Window : méthode clearTimeout()

Baseline Large disponibilité

Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis juillet 2015.

La méthode clearTimeout() de l'interface Window annule un délai précédemment établi en appelant Window.setTimeout().

Si le paramètre fourni n'identifie pas une action précédemment établie, cette méthode ne fait rien.

Dans cet article

Syntaxe

clearTimeout(timeoutID)

Paramètres

timeoutID

L'identifiant du délai que vous souhaitez annuler. Cet ID a été retourné par l'appel correspondant à setTimeout().

Il est utile de noter que l'ensemble d'ID utilisé par setTimeout() et setInterval() est partagé, ce qui signifie que vous pouvez techniquement utiliser clearTimeout() et clearInterval() de façon interchangeable. Cependant, pour plus de clarté, il est préférable d'éviter de le faire.

Valeur de retour

Aucune (undefined).

Exemples

Exécutez le script ci-dessous dans le contexte d'une page web et cliquez sur la page une fois. Vous verrez un message apparaître dans une seconde. Si vous cliquez plusieurs fois sur la page en une seconde, l'alerte n'apparaît qu'une seule fois.

js
const alarme = {
  rappel(message) {
    alert(message);
    this.timeoutID = undefined;
  },

  configurer() {
    if (typeof this.timeoutID === "number") {
      this.annuler();
    }

    this.timeoutID = setTimeout(
      (msg) => {
        this.rappel(msg);
      },
      1000,
      "Réveille-toi !",
    );
  },

  annuler() {
    clearTimeout(this.timeoutID);
  },
};
window.addEventListener("click", () => alarme.configurer());