WebTransport: congestionControl property

Limited availability

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

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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 congestionControl read-only property of the WebTransport interface indicates the application's preference for either high throughput or low-latency when sending data.

The value is set in the WebTransport() constructor options.

Value

A string with one of the following values:

default

The default congestion control tuning for the transport. This is the default.

throughput

The application prefers congestion control to be tuned for throughput.

low-latency

The application prefers congestion control to be tuned for low-latency.

Examples

This example shows how to get the congestionControl preference. As this is not explicitly set in the constructor, the result is default.

js
const url = "https://example.com:4999/wt";
const transport = new WebTransport(url);
console.log(transport.congestionControl); // default

Specifications

Specification
WebTransport
# dom-webtransport-congestioncontrol

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
congestionControl
Experimental

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
Experimental. Expect behavior to change in the future.
User must explicitly enable this feature.