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.

Documentation CloseEvent by Mozilla Contributors, licensed under CC-BY-SA 2.5.



new (type:String, ?eventInitDict:CloseEventInit)





read onlycode:Int

Returns an unsigned short containing the close code send by the server. The following values are permitted status codes.

Status code Name Description
0999   Reserved and not used.
1000 CLOSE_NORMAL Normal closure; the connection successfully completed whatever purpose for which it was created.
1001 CLOSE_GOING_AWAY The endpoint is going away, either because of a server failure or because the browser is navigating away from the page that opened the connection.
1002 CLOSE_PROTOCOL_ERROR The endpoint is terminating the connection due to a protocol error.
1003 CLOSE_UNSUPPORTED The connection is being terminated because the endpoint received data of a type it cannot accept (for example, a text-only endpoint received binary data).
1004   Reserved. A meaning might be defined in the future.
1005 CLOSE_NO_STATUS Reserved.  Indicates that no status code was provided even though one was expected.
1006 CLOSE_ABNORMAL Reserved. Used to indicate that a connection was closed abnormally (that is, with no close frame being sent) when a status code is expected.
1007 Unsupported Data The endpoint is terminating the connection because a message was received that contained inconsistent data (e.g., non-UTF-8 data within a text message).
1008 Policy Violation The endpoint is terminating the connection because it received a message that violates its policy. This is a generic status code, used when codes 1003 and 1009 are not suitable.
1009 CLOSE_TOO_LARGE The endpoint is terminating the connection because a data frame was received that is too large.
1010 Missing Extension The client is terminating the connection because it expected the server to negotiate one or more extension, but the server didn't.
1011 Internal Error The server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.
1012 Service Restart The server is terminating the connection because it is restarting. [Ref]
1013 Try Again Later The server is terminating the connection due to a temporary condition, e.g. it is overloaded and is casting off some of its clients. [Ref]
1014   Reserved for future use by the WebSocket standard.
1015 TLS Handshake Reserved. Indicates that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified).
10161999   Reserved for future use by the WebSocket standard.
20002999   Reserved for use by WebSocket extensions.
30003999   Available for use by libraries and frameworks. May not be used by applications. Available for registration at the IANA via first-come, first-serve.
40004999   Available for use by applications.

read onlyreason:String

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

read onlywasClean:Bool

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

Inherited Variables

Defined by Event

read onlybubbles:Bool

A Boolean indicating whether the event bubbles up through the DOM or not.

read onlycancelable:Bool

A Boolean indicating whether the event is cancelable.

read onlycurrentTarget:EventTarget

A reference to the currently registered target for the event. This is the object to which the event is currently slated to be sent to; it's possible this has been changed along the way through retargeting.

read onlydefaultPrevented:Bool

Indicates whether or not event.preventDefault() has been called on the event.

read onlyeventPhase:Int

Indicates which phase of the event flow is being processed.

read onlyexplicitOriginalTarget:EventTarget

The explicit original target of the event (Mozilla-specific).

read onlyisTrusted:Bool

Indicates whether or not the event was initiated by the browser (after a user click for instance) or by a script (using an event creation method, like event.initEvent)

read onlyoriginalTarget:EventTarget

The original target of the event, before any retargetings (Mozilla-specific).

read onlytarget:EventTarget

A reference to the target to which the event was originally dispatched.

read onlytimeStamp:Float

The time at which the event was created, in milliseconds. By specification, this value is time since epoch, but in reality browsers' definitions vary; in addition, work is underway to change this to be a DOMHighResTimeStamp instead.

read onlytype:String

The name of the event (case-insensitive).

Inherited Methods

Defined by Event

getPreventDefault ():Bool

Non-standard. Returns the value of Event.defaultPrevented. Use Event.defaultPrevented instead.

initEvent (type:String, bubbles:Bool, cancelable:Bool):Void

Initializes the value of an Event created. If the event has already being dispatched, this method does nothing.

preventDefault ():Void

Cancels the event (if it is cancelable).

stopImmediatePropagation ():Void

For this particular event, no other listener will be called. Neither those attached on the same element, nor those attached on elements which will be traversed later (in capture phase, for instance)

stopPropagation ():Void

Stops the propagation of events further along in the DOM.