Interface IClusterEventEmitter

The cluster event emitter interface.

interface IClusterEventEmitter {
    on: ClusterOnFunction;
    off(): void;
    off(event: string): void;
    off(events: string[]): void;
}

Hierarchy (view full)

IClusterEventEmitter
- ICluster

Index

Properties

Methods

Properties

on

on: ClusterOnFunction

Allows listening to events published on the cluster.

Type Param: U

Any of the events defined in IClusterEvents.

Param: event

One of the events defined in IClusterEvents.

Param: listener

The callback when the event is received. Listeners' payload are defined in IClusterEvents.

Methods

off

off(): void
Unsubscribe from all events on the cluster

Returns void
off(event): void
Unsubscribe to an event.
Parameters
- event: string
  The event to unsubscribe from.
Returns void
off(events): void
Unsubscribe from all events, or a specific list of events.
Parameters
- events: string[]
  The list of events to unsubscribe from.
Returns void