BroadcastChannel.close()

The BroadcastChannel.close() terminates the connection to the underlying channel, allowing the object to be garbage collected. This is a necessary step to perform as there is no other way for a browser to know that this channel is not needed anymore.

Note:

This feature is available in Web Workers.

Syntax

var str = channel.close();

Example

// Connect to a channel
var bc = new BroadcastChannel('test_channel');

// More operations (like postMessage, …)

// When done, disconnect from the channel
bc.close();

Specifications

Specification Status Comment
HTML Living Standard
The definition of 'BroadcastChannel.close()' in that specification.
Living Standard Initial definition.

Browser compatibility

BCD tables only load in the browser

See also