Cette page a été traduite à partir de l'anglais par la communauté. Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.

View in English Always switch to English

WebSocket : évènement close

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.

Note : Cette fonctionnalité est disponible via les Web Workers.

L'évènement close de l'interface WebSocket est déclenché lorsqu'une connexion avec une WebSocket est fermée.

Syntaxe

Utilisez le nom de l'évènement dans des méthodes comme addEventListener(), ou assignez une propriété de gestionnaire d'évènement.

js
addEventListener("close", (event) => { })

onclose = (event) => { }

Type d'évènement

Un objet CloseEvent. Hérite de l'objet Event.

Event CloseEvent

Exemples

Vous pouvez vouloir savoir quand la connexion a été fermée afin de mettre à jour l'interface utilisateur ou, peut-être, enregistrer des données concernant la connexion fermée. En supposant que vous ayez une variable appelée socketExemple qui fait référence à une WebSocket ouverte, ce gestionnaire permet de gérer la situation où la socket a été fermée.

js
socketExemple.addEventListener("close", (event) => {
  console.log("La connexion a été fermée avec succès.");
});

On peut effectuer les mêmes actions avec la propriété de gestion d'évènement correspondante :

js
socketExemple.onclose = (event) => {
  console.log("La connexion a été fermée avec succès.");
};

Spécifications

Spécification
WebSockets
# dom-websocket-onclose

Compatibilité des navigateurs

Voir aussi