BroadcastChannel

{{APIRef("Broadcast Channel API")}} {{AvailableInWorkers}}

The BroadcastChannel interface represents a named channel that any {{glossary("browsing context")}} of a given {{glossary("origin")}} can subscribe to. It allows communication between different documents (in different windows, tabs, frames or iframes) of the same origin. Messages are broadcasted via a {{domxref("BroadcastChannel/message_event", "message")}} event fired at all BroadcastChannel objects listening to the channel, except the object that sent the message.

{{InheritanceDiagram}}

Constructor

• {{domxref("BroadcastChannel.BroadcastChannel", "BroadcastChannel()")}}
  • : Creates an object linking to the named channel.

Instance properties

This interface also inherits properties from its parent, {{domxref("EventTarget")}}.

• {{domxref("BroadcastChannel.name")}} {{ReadOnlyInline}}
  • : Returns a string, the name of the channel.

Instance methods

This interface also inherits methods from its parent, {{domxref("EventTarget")}}.

• {{domxref("BroadcastChannel.postMessage()")}}
  • : Sends the message, of any type of object, to each BroadcastChannel object listening to the same channel.
• {{domxref("BroadcastChannel.close()")}}
  • : Closes the channel object, indicating it won't get any new messages, and allowing it to be, eventually, garbage collected.

Events

This interface also inherits events from its parent, {{domxref("EventTarget")}}.

• {{domxref("BroadcastChannel/message_event", "message")}}
  • : Fired when a message arrives on the channel. Also available via the onmessage property.
• {{domxref("BroadcastChannel/messageerror_event", "messageerror")}}
  • : Fired when a message arrives that can't be deserialized. Also available via the onmessageerror property.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Another, more heavyweight, way of communicating between browser contexts: {{domxref("ServiceWorker")}}.
• Broadcast Channel API overview