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.code
Read only-
Returns an
unsigned short
containing the close code sent by the server. CloseEvent.reason
Read only-
Returns a
DOMString
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.
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 theCloseEvent()
constructor instead.
Specifications
Specification |
---|
HTML Standard # the-closeevent-interface |
Browser compatibility
BCD tables only load in the browser