WebSocketStream: close() method

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 Optional

An options object containing the following properties:

closeCode Optional

A number representing the closing code (see the full list of CloseEvent status codes).

reason Optional

A string representing a human-readable description of the reason why the socket connection is closed. The maximum allowed length for a reason string is 123 bytes. The string is automatically encoded as UTF-8 when the function is invoked.

Return value

None (undefined).

Exceptions

SyntaxError DOMException

Thrown if the provided reason is 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

See also

• WebSocketStream: integrating streams with the WebSocket API, developer.chrome.com (2020)