clearInterval()
La méthode globale clearInterval()
permet d'annuler une action répétée minutée initiée via un appel à setInterval()
. Si le paramètre fourni ne permet pas d'identifier une action lancée précédemment, cette méthode n'a aucun effet.
Syntaxe
clearInterval(intervalID);
Paramètres
intervalID
-
L'identifiant de l'intervalle de répétition qu'on souhaite annuler. Cet identifiant est renvoyé lorsqu'on appelle
setInterval()
pour définir l'intervalle de répétition.
On notera que l'ensemble des identifiants utilisés est commun entre ceux fournis par setInterval()
et ceux fournis par setTimeout()
. Cela signifie qu'on peut, techniquement, utiliser clearInterval()
et clearTimeout()
de façon interchangeable. C'est toutefois une mauvaise pratique, qui nuit à la lisibilité du code et à sa maintenabilité.
Valeur de retour
Aucune (undefined
).
Exemples
Voir l'exemple setInterval()
.