WebSocketStream: close() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Note: This feature is available in Web Workers.
The close() method of the
WebSocketStream interface closes the WebSocket connection. The method optionally accepts an object containing a custom code and/or reason indicating why the connection was closed.
Syntax
close()
close(options)
Parameters
optionsOptional-
An options object containing the following properties:
closeCodeOptional-
A number representing the closing code (see the full list of
CloseEventstatus codes). reasonOptional-
A string representing a human-readable description of the reason why the socket connection is closed. The maximum allowed length for a
reasonstring is 123 bytes. The string is automatically encoded as UTF-8 when the function is invoked.
Note: Depending on the server setup and status code you use, the server may choose to ignore a custom code in favor of a valid code that is correct for the closing reason. Valid codes are 1000, and any code within the range 3000 to 4999, inclusive.
Return value
None (undefined).
Exceptions
SyntaxErrorDOMException-
Thrown if the provided
reasonis longer than the maximum allowed length of 123 bytes.
Examples
const wsURL = "wss://127.0.0.1/";
const wss = new WebSocketStream(wsURL);
setTimeout(() => {
wss.close({
closeCode: 1000,
reason: "That's all folks",
});
}, 10000);
Specifications
Not currently a part of any specification. See https://github.com/whatwg/websockets/pull/48 for standardization progress.
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
close
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
See also
- WebSocketStream: integrating streams with the WebSocket API, developer.chrome.com (2020)