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 message

Baseline Widely available

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 message de l'interface WebSocket est déclenché lorsque des données sont reçues via une WebSocket.

Syntaxe

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

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

onmessage = (event) => { }

Type d'évènement

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

Event MessageEvent

Propriétés de l'évènement

En plus des propriétés listées ci-dessous, les propriétés de l'interface parente, Event, sont disponibles.

data Lecture seule

Les données envoyées par l'émetteur du message. Le type de cette propriété dépend du type du message WebSocket et de la valeur de WebSocket.binaryType.

  • Si le type du message est "text", alors ce champ est une chaîne de caractères.
  • Si le type du message est "binary", alors le type de cette propriété peut être déduit du binaryType de ce socket :
    • ArrayBuffer si binaryType vaut "arraybuffer",
    • Blob si binaryType vaut "blob". Cela n'a pas de type média associé (Blob.type vaut "").
origin Lecture seule

Une chaîne de caractères représentant l'origine de l'émetteur du message.

Les autres propriétés de l'interface MessageEvent sont présentes, mais ne concernent pas l'API WebSocket et restent à leurs valeurs par défaut :

Exemples

js
// Crée une connexion WebSocket
const socket = new WebSocket("ws://localhost:8080");

// Écoute les différents messages
socket.addEventListener("message", (event) => {
  console.log("Message reçu du serveur ", event.data);
});

Spécifications

Specification
WebSockets
# dom-websocket-onmessage

Compatibilité des navigateurs

Voir aussi