CloseEvent

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.

Constructor

CloseEvent()

Creates a new CloseEvent.

Properties

This interface also inherits properties from its parent, Event.

CloseEvent.codeRead only

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

CloseEvent.reasonRead only

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

CloseEvent.wasCleanRead only

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

Methods

This interface also inherits methods from its parent, Event.

CloseEvent.initCloseEvent()

Initializes the value of a CloseEvent created. If the event has already being dispatched, this method does nothing. Do not use this method anymore, use the CloseEvent() constructor instead.

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
CloseEvent
13
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."]
10
12.1
6
≤37
18
8
12.1
6
1.0
CloseEvent
16
14
8
No
?
6
≤37
18
8
?
6
1.0
code
15
12
8
10
≤15
6
≤37
18
8
≤14
6
1.0
initCloseEvent
No
12-79
8-41
No
No
No
No
No
8-41
No
No
No
reason
15
12
8
10
≤15
6
≤37
18
8
≤14
6
1.0
wasClean
13
12
8
10
≤15
6
≤37
18
8
≤14
6
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/CloseEvent