CloseEvent

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.

A CloseEvent is sent to clients using WebSockets when the connection is closed. This is delivered to the listener indicated by the WebSocket object's onclose attribute.

Event CloseEvent

Constructor

CloseEvent()

Creates a new CloseEvent.

Instance properties

This interface also inherits properties from its parent, Event.

CloseEvent.code Read only

Returns an unsigned short containing the close code sent by the server.

CloseEvent.reason Read only

Returns a string indicating the reason the server closed the connection. This is specific to the particular server and sub-protocol.

CloseEvent.wasClean Read only

Returns a boolean value that Indicates whether or not the connection was cleanly closed.

Instance methods

This interface also inherits methods from its parent, Event.

Specifications

Specification
WebSockets Standard
# the-closeevent-interface

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Opera Safari Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet WebView Android
CloseEvent 16 14 11 12.1 6 18 14 12.1 6 1.0 4.4
CloseEvent 15 12
8["Before Firefox 12, the close code CLOSE_NORMAL was used when the channel was closed due to an unexpected error or unspecified error condition.", "Before Firefox 8, the WebSocket close event was sent to the listener as a simple event."]
 12.1 6 18 8 12.1 6 1.0 4.4
code 15 12 8 12.1 6 18 8 12.1 6 1.0 4.4
reason 15 12 8 12.1 6 18 8 12.1 6 1.0 4.4
wasClean 15 12 8 12.1 6 18 8 12.1 6 1.0 4.4

See also

© 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/CloseEvent