The close
event is fired when a connection with a WebSocket
is closed.
The close
event is fired when a connection with a WebSocket
is closed.
Use the event name in methods like addEventListener()
, or set an event handler property.
js
addEventListener("close", (event) => {}); onclose = (event) => {};
A CloseEvent
. Inherits from Event
.
In addition to the properties listed below, properties from the parent interface, Event
, are available.
code
Read only
Returns an unsigned short
containing the close code sent by the server.
reason
Read only
Returns a string indicating the reason the server closed the connection. This is specific to the particular server and sub-protocol.
wasClean
Read only
Returns a boolean value that Indicates whether or not the connection was cleanly closed.
You might want to know when the connection has been closed so that you can update the UI or, perhaps, save data about the closed connection. Given that you have a variable called exampleSocket
that refers to an opened WebSocket
, this handler would handle the situation where the socket has been closed.
js
exampleSocket.addEventListener("close", (event) => { console.log("The connection has been closed successfully."); });
You can perform the same actions using the event handler property, like this:
js
exampleSocket.onclose = (event) => { console.log("The connection has been closed successfully."); };
Specification |
---|
WebSockets Standard # dom-websocket-onclose |
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
close_event |
5 | 12 | 7 | 10 | 12.1 | 5 | ≤37 | 18 | 7 | 12.1 | 4.2 | 1.0 |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close_event