RTCDataChannel: closing event

The closing event is sent to an RTCDataChannel just before the channel begins the process of shutting down its underlying data transport.

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("closing", (event) => {});

onclosing = (event) => {};

Event type

A generic Event.

Description

While the closing event is sent to the channel just before beginning to close the channel's data transport, the close event is sent once the closing process is complete.

Examples

This example updates a connection status interface when the closing event arrives.

First, an example using addEventListener():

js
dataChannel.addEventListener("closing", (ev) => {
  myConnectionStatus.icon = closingIcon;
  myConnectionStatus.text = "Connection closing";
});

You can also set the onclosing event handler property directly:

js
pc.onclosing = (ev) => {
  myConnectionStatus.icon = closingIcon;
  myConnectionStatus.text = "Connection closing";
};

Specifications

Specification
WebRTC: Real-Time Communication in Browsers
# event-datachannel-closing
WebRTC: Real-Time Communication in Browsers
# dom-rtcdatachannel-onclosing

Browser compatibility

BCD tables only load in the browser

See also