Class DualBroadcastChannel

An extended BroadcastChannel that uses a second BroadcastChannel to post messages, such that this instance can receive messages sent by itself.

Hierarchy

BroadcastChannel
- DualBroadcastChannel

Index

Constructors

Properties

name onmessage onmessageerror publisher

Methods

addEventListener close dispatchEvent postMessage removeEventListener

Constructors

constructor

new DualBroadcastChannel(name): DualBroadcastChannel
Parameters
- name: string
  The channel name.
Returns DualBroadcastChannel
Overrides BroadcastChannel.constructor
- Defined in packages/messaging/src/utils/dual-broadcast.ts:8

Properties

`Readonly` name

name: string

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

onmessage

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

Type declaration

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

onmessageerror

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

Type declaration

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

`Private` `Readonly` publisher

publisher: BroadcastChannel

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
Inherited from BroadcastChannel.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:3189
addEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from BroadcastChannel.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:3190

close

close(): void
Returns void
Overrides BroadcastChannel.close
- Defined in packages/messaging/src/utils/dual-broadcast.ts:20

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 BroadcastChannel.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:8217

postMessage

postMessage(message): void
Parameters
- message: unknown
Returns void
Overrides BroadcastChannel.postMessage
- Defined in packages/messaging/src/utils/dual-broadcast.ts:16

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
Inherited from BroadcastChannel.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:3191
removeEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from BroadcastChannel.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:3192

Generated using TypeDoc