-
Notifications
You must be signed in to change notification settings - Fork 22.4k
/
index.md
57 lines (37 loc) · 2.16 KB
/
index.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
---
title: BroadcastChannel
slug: Web/API/BroadcastChannel
page-type: web-api-interface
browser-compat: api.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](/en-US/docs/Web/API/Broadcast_Channel_API)