MessageBusSink

Experimental Interface

Interface Overview

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

Interface Description

Interface Details

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

Sets up a new channel on the MessageBusSink. MUST be called before calling to on the channel. If runInZone is true the sink will buffer messages and send only once the zone exits. if runInZone is false the sink will send messages immediatly.

attachToZone(zone: NgZone) : void

Assigns this sink to the given zone. Any channels which are initialized with runInZone set to true will wait for the given zone to exit before sending messages.

to(channel: string) : EventEmitter<any>

Returns an EventEmitter for the given channel To publish methods to that channel just call next on the returned emitter

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