Type alias BatchClusterEmitter

BatchClusterEmitter: TypedEventEmitter<BatchClusterEvents>

The BatchClusterEmitter signature is built up automatically by the BatchClusterEvents interface, which ensures .on, .off, and .emit signatures are all consistent, and include the correct data payloads for all of BatchCluster's events.

This approach has some benefits:

  • it ensures that on(), off(), and emit() signatures are all consistent,
  • supports editor autocomplete, and
  • offers strong typing,

but has one drawback:

  • jsdocs don't list all signatures directly: you have to visit the event source interface.

See BatchClusterEvents for a the list of events and their payload signatures

Generated using TypeDoc