This is the archived documentation for Angular v6. Please visit angular.io to see documentation for the current version of Angular.
API > @angular/platform-webworker

MessageBusSink

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

Class implementations

Methods

initChannel()

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 immediately.
initChannel(channel: string, runInZone: boolean): void
      
      initChannel(channel: string, runInZone: boolean): void

Parameters

channel

Type: string.
runInZone

Type: boolean.

Returns

void

attachToZone()

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.
attachToZone(zone: NgZone): void
      
      attachToZone(zone: NgZone): void

Parameters

zone

Type: NgZone.

Returns

void

to()

Returns an EventEmitter for the given channel To publish methods to that channel just call next on the returned emitter
to(channel: string): EventEmitter<any>
      
      to(channel: string): EventEmitter<any>

Parameters

channel

Type: string.

Returns

EventEmitter<any>