MDN self-hosted library · e01.org

CloseEvent: reason property

Websockets API

Open notebook · 1 cells web-api-instance-property upstream source

Websockets API

The reason read-only property of the 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

Browser compatibility

See also

  • RFC 6455 (the WebSocket Protocol specification)