Skip to content

index.md

Latest commit

 

History

History
44 lines (28 loc) · 1.24 KB

index.md

File metadata and controls

44 lines (28 loc) · 1.24 KB
title CloseEvent
slug Web/API/CloseEvent
page-type web-api-interface
browser-compat api.CloseEvent

{{APIRef("Websockets API")}}{{AvailableInWorkers}}

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

{{InheritanceDiagram}}

Constructor

  • {{domxref("CloseEvent.CloseEvent", "CloseEvent()")}}
    • : Creates a new CloseEvent.

Instance properties

This interface also inherits properties from its parent, {{domxref("Event")}}.

  • {{domxref("CloseEvent.code")}} {{ReadOnlyInline}}
    • : Returns an unsigned short containing the close code.
  • {{domxref("CloseEvent.reason")}} {{ReadOnlyInline}}
    • : Returns a string indicating the reason the server closed the connection. This is specific to the particular server and sub-protocol.
  • {{domxref("CloseEvent.wasClean")}} {{ReadOnlyInline}}
    • : Returns a boolean value that Indicates whether or not the connection was cleanly closed.

Instance methods

This interface also inherits methods from its parent, {{domxref("Event")}}.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{domxref("WebSocket")}}