BroadcastChannel
The BroadcastChannel
interface represents a named channel that any browsing context of a given 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 message
event fired at all BroadcastChannel
objects listening to the channel.
Note:
This feature is available in Web Workers.Constructor
BroadcastChannel()
- Creates an object linking to the named channel.
Properties
This interface also inherits properties from its parent, EventTarget
.
BroadcastChannel.name
Read only- Returns a
DOMString
, the name of the channel.
Event handlers
BroadcastChannel.onmessage
- An
EventHandler
property that specifies the function to execute when amessage
event is fired on this object. BroadcastChannel.onmessageerror
- An
EventHandler
called when aMessageEvent
of typeMessageError
is fired—that is, when it receives a message that cannot be deserialized.
Methods
This interface also inherits methods from its parent, EventTarget
.
BroadcastChannel.postMessage()
- Sends the message, of any type of object, to each
BroadcastChannel
object listening to the same channel. BroadcastChannel.close()
- Closes the channel object, indicating it won't get any new messages, and allowing it to be, eventually, garbage collected.
Events
message
- Fired when a message arrives on the channel.
Also available via theonmessage
property. messageerror
- Fired when a message arrives that can't be deserialized.
Also available via theonmessageerror
property.
Specifications
Specification | Status | Comment |
---|---|---|
HTML Living Standard The definition of 'BroadcastChannel' in that specification. |
Living Standard | Initial definition. |
Browser compatibility
BCD tables only load in the browser
See also
- Another, more heavyweight, way of communicating between browser contexts:
ServiceWorker
. - Broadcast Channel API overview