BroadcastChannel - Messaging - Web documentation

Messaging

BroadcastChannel

interface BroadcastChannel

extends EventTarget

unstable

Properties #

readonly

#name: string

Returns the channel name (as passed to the constructor).

#onmessage: ((this: BroadcastChannel,
ev: MessageEvent,
) => any) | null

#onmessageerror: ((this: BroadcastChannel,
ev: MessageEvent,
) => any) | null

Methods #

#close(): void

Closes the BroadcastChannel object, opening it up to garbage collection.

#postMessage(message: any): void

Sends the given message to other BroadcastChannel objects set up for this channel. Messages can be structured objects, e.g. nested objects and arrays.

#addEventListener<K extends keyof BroadcastChannelEventMap>(type: K,
listener: (this: BroadcastChannel,
ev: BroadcastChannelEventMap[K],
) => any,
options?: boolean | AddEventListenerOptions,
): void

#addEventListener(type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | AddEventListenerOptions,
): void

#removeEventListener<K extends keyof BroadcastChannelEventMap>(type: K,
listener: (this: BroadcastChannel,
ev: BroadcastChannelEventMap[K],
) => any,
options?: boolean | EventListenerOptions,
): void

#removeEventListener(type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | EventListenerOptions,
): void

variable BroadcastChannel

unstable

Properties #

readonly

#prototype: BroadcastChannel