MessageBusSource

Experimental Interface

Interface Overview

interface MessageBusSource {
  initChannel(channel: string, runInZone: boolean) : void
  attachToZone(zone: NgZone) : void
  from(channel: string) : EventEmitter<any>
}

Interface Description

Interface Details

initChannel(channel: string, runInZone: boolean) : void

Sets up a new channel on the MessageBusSource. MUST be called before calling from on the channel. If runInZone is true then the source will emit events inside the angular zone. if runInZone is false then the source will emit events inside the global zone.

attachToZone(zone: NgZone) : void

Assigns this source to the given zone. Any channels which are initialized with runInZone set to true will emit events that will be executed within the given zone.

from(channel: string) : EventEmitter<any>

Returns an EventEmitter that emits every time a message is received on the given channel.

exported from @angular/platform-webworker/index, defined in @angular/platform-webworker/src/web_workers/shared/message_bus.ts