WebSocket: close event

The close event is fired when a connection with a WebSocket is closed.

Bubbles No
Cancelable No
Interface CloseEvent
Event handler property onclose

Examples

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.

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:

exampleSocket.onclose = function (event) {
  console.log('The connection has been closed successfully.');
};

Specifications

Browser compatibility

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
4
12
7
10
12.1
5
≤37
18
7
12.1
4.2
1.0

See also

© 2005–2021 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