web.broadcast.BroadcastChannel — clojure-interop/cljs-web-api 1.0.10

The BroadcastChannel interface represents a named channel that browsing context of a given origin can subscribe to. It allows between different documents (in different windows, tabs, frames iframes) of the same origin. Messages are broadcasted via a message fired at all BroadcastChannel objects listening to the channel.

close cljs

(close this)

Method.

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

var str = channel.close();

See also: https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel/close

constructor cljs

(constructor & args)

Constructor.

The BroadcastChannel() constructor creates a new web.broadcast.BroadcastChannel and connects it to the underlying channel.

See also: https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel/BroadcastChannel

name cljs

(name this)

Property.

[Read Only]

The read-only BroadcastChannel.name property returns a web.DOMString, uniquely identifies the given channel with its name. This name passed to the BroadcastChannel() constructor at creation time is therefore read-only.

var str = channel.name;

See also: https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel/name

onmessage cljs

(onmessage this)

Property.

The BroadcastChannel.onmessage event handler is a property that the function to execute when a message event, of type web.workers.MessageEvent, received by this web.broadcast.BroadcastChannel. Such an event sent by the browser with a message broadcasted to the channel.

channel.onmessage = function;

See also: https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel/onmessage

onmessageerror cljs

(onmessageerror this)

Property.

The onmessageerror event handler of the web.broadcast.BroadcastChannel is an web.other.EventListener, called whenever an web.workers.MessageEvent type messageerror is fired on the BroadcastChannel instance — is, when it receives a message that cannot be deserialized.

bc.onmessageerror = function() { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel/onmessageerror

post-message cljs

(post-message this object)

Method.

The BroadcastChannel.postMessage() sends a message, which can of any kind of js.Object, to each listener in any browsing with the same origin. The message is transmitted as a message targeted at each BroadcastChannel bound to the channel.

var str = channel.postMessage(object);

See also: https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel/postMessage

set-onmessage! cljs

(set-onmessage! this val)

Property.

The BroadcastChannel.onmessage event handler is a property that the function to execute when a message event, of type web.workers.MessageEvent, received by this web.broadcast.BroadcastChannel. Such an event sent by the browser with a message broadcasted to the channel.

channel.onmessage = function;

See also: https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel/onmessage

set-onmessageerror! cljs

(set-onmessageerror! this val)

Property.

The onmessageerror event handler of the web.broadcast.BroadcastChannel is an web.other.EventListener, called whenever an web.workers.MessageEvent type messageerror is fired on the BroadcastChannel instance — is, when it receives a message that cannot be deserialized.

bc.onmessageerror = function() { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel/onmessageerror