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.
addEventListener("message", (event) => { })
onmessage = (event) => { }
Type d'évènement
Un objet MessageEvent. Hérite de l'objet Event.
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.
dataLecture 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 dubinaryTypede ce socket :ArrayBuffersibinaryTypevaut"arraybuffer",BlobsibinaryTypevaut"blob". Cela n'a pas de type média associé (Blob.typevaut"").
- Si le type du message est
originLecture 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 :
lastEventIdLecture seulesourceLecture seuleportsLecture seule
Exemples
// 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> |