Documentation

Events

Events allow for applications to use the observer pattern, which allows subscribing and publishing events, outside the normal execution paths.

TYPES

<src>Listener⇒ (args: Array< any >) => void

A callback function called when a an event is triggered.

interface EventEmitterable

An EventEmitterable behaves similar to an EventEmitter except provides async access to its methods.

An EventEmitter implements the observer pattern.

METHODS

<src>eventEmitterable.addListener(event: T, listener: Listener)⇒ Promise< this >

Alias for on.

<src>eventEmitterable.emit(event: T, args: Array< any >)⇒ Promise< boolean >

Triggers each listener for event with the args.

<src>eventEmitterable.listenerCount(event?: T)⇒ Promise< number >

Resolves to the number of listeners for event.

<src>eventEmitterable.listeners(event?: T)⇒ Promise< Array< Listener > >

Resolves to the listeners for event.

<src>eventEmitterable.off(event: T, listener?: Listener)⇒ Promise< this >

Unregister the listener for event. If listener is unspecified, all listeners are unregistered.

<src>eventEmitterable.on(event: T, listener: Listener)⇒ Promise< this >

Registers a listener that is called whenever the event occurs until unregistered.

<src>eventEmitterable.once(event: T, listener: Listener)⇒ Promise< this >

Registers a listener that is called the next time event occurs.

<src>eventEmitterable.removeAllListeners(event?: T)⇒ Promise< this >

Unregister all listeners for event.

<src>eventEmitterable.removeListener(event: T, listener: Listener)⇒ Promise< this >

Alias for off.

class EventPayload

When an EventEmitterable triggers a Listener, the callback always ahas one additional argument passed, which is an EventPayload.

PROPERTIES

<src>eventPayload.emitter⇒ EventEmitterable < T >read-only

The EventEmitterable.

<src>eventPayload.filter⇒ Tread-only

The event filter.

CREATING INSTANCES

<src>new EventPayload(emitter: EventEmitterable < T >, listener: null | Listener, filter: T)

Create a new EventPayload for emitter with the listener and for filter.

METHODS

<src>eventPayload.removeListener()⇒ Promise< void >

Unregister the triggered listener for future events.