CloseEvent: reason property

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

The reason read-only property of the {{domxref("CloseEvent")}} interface returns the WebSocket connection close reason the server gave for closing the connection; that is, a concise human-readable prose explanation for the closure.

Value

A string.

Examples

The following example prints the value of reason to the console.

WebSocket.onclose = (event) => {
  console.log(event.reason);
};

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• RFC 6455 (the WebSocket Protocol specification)