W3cubDocs

/Web APIs

WebTransport: close() method

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

Note: This feature is available in Web Workers

Syntax

js

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

js

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

// ...

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

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
close 97 97 114 No 83 No 97 97 114 68 No 18.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebTransport/close