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.
CloseEvent.reason
Value
A string.
Examples
The following example prints the value of reason to the console.
WebSocket.onclose = function(event) { console.log(event.reason); };
Specifications
| Specification |
|---|
| WebSockets Standard # ref-for-dom-closeevent-reason② |
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
reason |
15
|
12
|
8
|
10
|
≤15
|
6
|
4.4
|
18
|
8
|
≤14
|
6
|
1.0
|
See also
- RFC 6455 (the WebSocket Protocol specification)
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent/reason
