W3cubDocs

/Angular 10

MessageBusSink

interface deprecated

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

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

Parameters
channel string
runInZone 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

Parameters
zone 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>

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/MessageBusSink