WebSockets API
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
options- : An options object containing the following properties:
closeCode- : A number representing the closing code (see the full list of
CloseEventstatus codes).
- : A number representing the closing code (see the full list of
reason- : 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.
- : A string representing a human-readable description of the reason why the socket connection is closed. The maximum allowed length for a
- : An options object containing the following properties:
[!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.
- : Thrown if the provided
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
See also
- WebSocketStream: integrating streams with the WebSocket API, developer.chrome.com (2020)
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
