WebSocket: message event

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Das message-Ereignis wird ausgelöst, wenn Daten über einen WebSocket empfangen werden.

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener() oder setzen Sie eine Ereignishandler-Eigenschaft.

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

onmessage = (event) => { }

Ereignistyp

Ein MessageEvent. Erbt von Event.

Ereigniseigenschaften

Neben den unten aufgelisteten Eigenschaften sind die Eigenschaften der Elternschnittstelle, Event, verfügbar.

data Schreibgeschützt

Die vom Nachrichten-Emitter gesendeten Daten. Der Typ dieser Eigenschaft hängt vom Typ der WebSocket-Nachricht und dem Wert von WebSocket.binaryType ab.

Wenn der Nachrichtentyp "text" ist, ist dieses Feld ein String.
Wenn der Nachrichtentyp "binary" ist, kann der Typ dieser Eigenschaft vom binaryType dieses Sockets abgeleitet werden:
- ArrayBuffer falls binaryType "arraybuffer" ist,
- Blob falls binaryType "blob" ist. Dies hat keinen zugehörigen Medientyp (Blob.type ist "").

origin Schreibgeschützt

Ein String, der die Herkunft des Nachrichten-Emitters repräsentiert.

Andere Eigenschaften der MessageEvent-Schnittstelle sind vorhanden, beziehen sich jedoch nicht auf die WebSocket-API und bleiben auf ihren Standardwerten:

lastEventId Schreibgeschützt
source Schreibgeschützt
ports Schreibgeschützt

Beispiele

// Create WebSocket connection.
const socket = new WebSocket("ws://localhost:8080");

// Listen for messages
socket.addEventListener("message", (event) => {
  console.log("Message from server ", event.data);
});

Spezifikationen

Specification
WebSockets # dom-websocket-onmessage