W3cubDocs

/Angular 10

MessageBus

class deprecated

Message Bus is a low level API used to communicate between the UI and the background. Communication is based on a channel abstraction. Messages published in a given channel to one MessageBusSink are received on the same channel by the corresponding MessageBusSource.

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

abstract class MessageBus implements MessageBusSource, MessageBusSink {
  abstract initChannel(channel: string, runInZone?: boolean): void
  abstract attachToZone(zone: NgZone): void
  abstract from(channel: string): EventEmitter<any>
  abstract to(channel: string): EventEmitter<any>
}

Methods

initChannel()

Sets up a new channel on the MessageBus. MUST be called before calling from or to on the channel. If runInZone is true then the source will emit events inside the angular zone and the sink will buffer messages and send only once the zone exits. if runInZone is false then the source will emit events inside the global zone and the sink will send messages immediately.

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

Parameters
channel string
runInZone boolean

Optional. Default is undefined.
Returns

void
attachToZone()

Assigns this bus to the given zone. Any callbacks attached to channels where runInZone was set to true on initialization will be executed in the given zone.

abstract 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.

abstract from(channel: string): EventEmitter<any>

Parameters
channel string
Returns

EventEmitter<any>
to()

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

abstract to(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/MessageBus