ContextQMD
Back to Content

WebTransport: ready property

files/en-us/web/api/webtransport/ready/index.md

latest1.5 KB
Original Source

{{APIRef("WebTransport API")}}{{SecureContext_Header}} {{AvailableInWorkers}}

The ready read-only property of the {{domxref("WebTransport")}} interface returns a promise that resolves when the transport is ready to use.

This promise is created when the WebTransport object is created and is resolved when a connection is established. Accessing or awaiting this promise does not trigger any action; it only allows actions to be taken when the transport is ready, similar to listening to an event.

Value

A {{jsxref("Promise")}} that resolves to undefined.

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

{{Specifications}}

Browser compatibility

{{Compat}}

See also