W3cubDocs

/Angular 10

MessageBusSource

interface deprecated

Deprecated: platform-webworker is deprecated in Angular and will be removed in a future version of Angular

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

Class implementations

Methods

initChannel()

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.

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

Parameters
channel string
runInZone boolean
Returns

void
attachToZone()

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.

attachToZone(zone: NgZone): void

Parameters
zone NgZone
Returns

void
from()

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

from(channel: string): EventEmitter<any>

Parameters
channel string
Returns

EventEmitter<any>

© 2010–2020 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v10.angular.io/api/platform-webworker/MessageBusSource