WebTransportError: WebTransportError() constructor

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 WebTransportError() constructor creates a new WebTransportError object instance.

Syntax

js
new WebTransportError(init)

Parameters

init Optional

An object containing the following properties:

message

A string describing the error that has occurred.

streamErrorCode

A number in the range 0-255 indicating the application protocol error code for this error.

Examples

A developer would not use this constructor manually. A new WebTransportError object is constructed when an error related to WebTransport occurs, for example a server error or network connection problem.

js
const url = "not-a-url";

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

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

    // ...
  } catch (error) {
    const msg = `Transport initialization failed.
                 Reason: ${error.message}.
                 Source: ${error.source}.
                 Error code: ${error.streamErrorCode}.`;
    console.log(msg);
  }
}

Specifications

Specification
WebTransport
# dom-webtransporterror-webtransporterror

Browser compatibility

desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
WebTransportError() constructor

See also