CloseEvent()

The CloseEvent() constructor creates a new CloseEvent.

Syntax

var event = new CloseEvent(typeArg, closeEventInit);

Values

typeArg
Is a DOMString representing the name of the event.
closeEventInit Optional
Is a CloseEventInit dictionary, having the following fields:
  • "wasClean", optional and defaulting to false, of type long, indicates if the connection has been closed cleanly or not.
  • "code", optional and defaulting to 0, of type unsigned short, that is the connection close code sent by the server.
  • "reason", optional and defaulting to '', of type DOMString, that is a human-readable reason why the server closed the connection.

The CloseEventInit dictionary also accepts fields from the EventInit dictionary.

Specifications

Specification Status Comment
HTML Living Standard
The definition of 'CloseEvent()' in that specification.
Living Standard Initial definition.

Browser compatibility

BCD tables only load in the browser

See also

  • CloseEvent, the interface of the objects it constructs.