Options
All
  • Public
  • Public/Protected
  • All
Menu

Receives events broadcast by an LiveEventSource.

remarks

All live event targets are also sources. This simplifies the programming model for live event object by letting them create a single object thats capable of broadcasting events to other instances of itself.

Type Parameters

Hierarchy

Index

Constructors

Methods

Constructors

Methods

  • sendEvent(evt?: Partial<TEvent>): TEvent
  • Broadcasts an event to any listening LiveEventTarget instances.

    Parameters

    • evt: Partial<TEvent> = {}

      Optional. Partial event object to send. The ILiveEvent.name, ILiveEvent.timestamp, and ILiveEvent.clientId fields will be automatically populated prior to sending.

    Returns TEvent

    The full event, including ILiveEvent.name, ILiveEvent.timestamp, and ILiveEvent.clientId fields if known.

Generated using TypeDoc