WebTransport: close() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Note: This feature is available in Web Workers.

The close() method of the WebTransport interface closes an ongoing WebTransport session.

Syntax

close(info)

Parameters

info Optional

An object containing the following properties:

closeCode: A number representing the error code for the error.
reason: A string representing the reason for closing the WebTransport.

Return value

undefined.

Exceptions

WebTransportError: Thrown if close() is invoked while the WebTransport is in the process of connecting.

Examples

const url = "https://example.com:4999/wt";
// Initialize transport connection
const transport = new WebTransport(url);

// ...

transport.close({
  closeCode: 017,
  reason: "CloseButtonPressed",
});

Specifications

Specification
WebTransport # dom-webtransport-close

Browser compatibility

BCD tables only load in the browser