WebTransport: closed property

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 closed read-only property of the WebTransport interface returns a promise that resolves when the transport is closed.

Value

A Promise that resolves to 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.

Examples

js
const url = "https://example.com:4999/wt";

async function initTransport(url) {
  // Initialize transport connection
  const transport = new WebTransport(url);

  // The connection can be used once ready fulfills
  await transport.ready;

  // ...
}

// ...

async function closeTransport(transport) {
  // Respond to connection closing
  try {
    await transport.closed;
    console.log(`The HTTP/3 connection to ${url} closed gracefully.`);
  } catch (error) {
    console.error(`The HTTP/3 connection to ${url} closed due to ${error}.`);
  }
}

Specifications

Specification
WebTransport
# dom-webtransport-closed

Browser compatibility

BCD tables only load in the browser

See also