Interface BroadcastChannel

Hierarchy

EventTarget
- BroadcastChannel

Index

Properties

name onmessage onmessageerror

Methods

addEventListener close dispatchEvent postMessage removeEventListener

Properties

`Readonly` name

name: string

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

onmessage

onmessage: ((this, ev) => any)

Type declaration

- (this, ev): any
- MDN Reference
  Parameters
  - this: BroadcastChannel
  - ev: MessageEvent<any>
  Returns any

onmessageerror

onmessageerror: ((this, ev) => any)

Type declaration

- (this, ev): any
- MDN Reference
  Parameters
  - this: BroadcastChannel
  - ev: MessageEvent<any>
  Returns any

Methods

addEventListener

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

Overrides EventTarget.addEventListener
addEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

Overrides EventTarget.addEventListener

close

close(): void
Closes the BroadcastChannel object, opening it up to garbage collection.

MDN Reference

Returns void

dispatchEvent

dispatchEvent(event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference
Parameters
- event: Event
Returns boolean

Inherited from EventTarget.dispatchEvent

postMessage

postMessage(message): 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.

MDN Reference
Parameters
- message: any
Returns void

removeEventListener

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

Overrides EventTarget.removeEventListener
removeEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

Overrides EventTarget.removeEventListener