CloseEvent: reason property
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
Note: This feature is available in Web Workers.
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.
js
WebSocket.onclose = (event) => {
console.log(event.reason);
};
Specifications
Specification |
---|
WebSockets # ref-for-dom-closeevent-reason② |
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | server | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
reason |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
See also
- RFC 6455 (the WebSocket Protocol specification)