Class Event<T, ReturnType>

The Event class implements a multi-cast event that can invoke any number of lambdas, functions or other events that have subscribed to the event.

Type Parameters

T extends any[]
ReturnType = void

Index

Constructors

Accessors

hasSubscribers isEmpty subscriberCount

Methods

add addWeak clear invoke remove removeObject removeWeak

Constructors

constructor

new Event<T, ReturnType>(subscriber?, didChangeListeningState?): Event<T, ReturnType>
Type Parameters
- T extends any[]
- ReturnType = void
Parameters
- Optionalsubscriber: EventSubscriberTypes<T, ReturnType>
- OptionaldidChangeListeningState: EventDidChangeListeningState
Returns Event<T, ReturnType>

Accessors

hasSubscribers

get hasSubscribers(): boolean
Determines whether the event has at least 1 subscriber.

Returns boolean

isEmpty

get isEmpty(): boolean
Determines whether the event has at least 1 subscriber.

Returns boolean

subscriberCount

get subscriberCount(): number
Gets the number of subscribers.

Returns number

Methods

add

add(subscriber): EventSubscriber<T, ReturnType>
Subscribes the subscriber to this event.
Parameters
- subscriber: EventSubscriberTypes<T, ReturnType>
Returns EventSubscriber<T, ReturnType>
add(object, callback?): EventSubscriber<T, ReturnType>
Subscribes the callback bound to object to this event.
Parameters
- object: object
- Optionalcallback: ((...args: T) => ReturnType)
  - - (...args): ReturnType
    - Parameters
      Rest...args: T
      Returns ReturnType
Returns EventSubscriber<T, ReturnType>

addWeak

addWeak(subscriber): EventSubscriber<T, ReturnType>
Subscribes the subscriber to this event.
Parameters
- subscriber: EventSubscriberTypes<T, ReturnType>
Returns EventSubscriber<T, ReturnType>

clear

clear(): void
Removes all subscribers.

Returns void

invoke

invoke(...args): ReturnType
Invokes this event.
Parameters
- Rest...args: T
Returns ReturnType

remove

remove(subscriber): void
Removes the subscriber from this event.
Parameters
- subscriber: EventSubscriberTypes<T, ReturnType>
Returns void
Note
If the object was added using addWeak you must use removeWeak to remove it instead.
remove(object, callback?): void
Removes the callback for the specified object from this event.
Parameters
- object: object
- Optionalcallback: ((...args: T) => ReturnType)
  - - (...args): ReturnType
    - Parameters
      Rest...args: T
      Returns ReturnType
Returns void
Note
If the object was added using addWeak you must use removeWeak to remove it instead.

removeObject

removeObject(subscriber): void
Removes all registered subscriptions for subscriber from this event.
Parameters
- subscriber: object
Returns void

removeWeak

removeWeak(subscriber): void
Removes all registered subscriptions for the subscriber from this event that were registered using addWeak.
Parameters
- subscriber: object
Returns void