Class EventDispatcher<T>

Type Parameters

T

Hierarchy

default
- EventDispatcher

Implements

EventRegistry<T>

Index

Constructors

Accessors

event onDispose subscribe

Methods

_onDispose add clear createSubscribe dispatch register remove

Constructors

constructor

new EventDispatcher<T>(behavior?: EventDispatchBehavior, finalizer?: (() => void)): EventDispatcher<T>
Type Parameters
- T
Parameters
- Optional behavior: EventDispatchBehavior
- Optional finalizer: (() => void)
  - - (): void
    - Returns void
Returns EventDispatcher<T>
Overrides DisposableBase.constructor
- Defined in EventDispatcher.ts:36

Accessors

event

get event(): Event<T>
The scope independent event registry for subscribing and managing listeners.

Returns

Returns Event<T>
- Defined in EventDispatcher.ts:64

onDispose

get onDispose(): Event<void>
A lazy-initialized event for listening for disposal.

Returns

Returns Event<void>
- Defined in EventDispatcher.ts:73

subscribe

get subscribe(): Subscribe<T>
The scope independent function for subscribing to an event.

Returns

Returns Subscribe<T>
- Defined in EventDispatcher.ts:54

Methods

`Protected` _onDispose

_onDispose(): void
Returns void
Overrides DisposableBase._onDispose
- Defined in EventDispatcher.ts:166

add

add(listener: Listener<T>): number
Attempts to add a listener.

Throws
ArgumentNullException if the listener is null.

Throws
ArgumentException if the listener already exists.

Returns
The registered Id of the listener. Returns NaN if this has been disposed.
Parameters
- listener: Listener<T>
Returns number
Implementation of EventRegistry.add
- Defined in EventDispatcher.ts:112

clear

clear(): number
Clears all listeners.

Returns
The number of listeners cleared. Returns NaN if this has been disposed.

Returns number
Implementation of EventRegistry.clear
- Defined in EventDispatcher.ts:124

`Protected` createSubscribe

createSubscribe(): Subscribe<T>
Creates a scope independent function for subscribing to an event.

Returns

Returns Subscribe<T>
- Defined in EventDispatcher.ts:181

dispatch

dispatch(payload: T): void
Dispatches payload to listeners.

Throws
ObjectDisposedException If this has been disposed.
Parameters
- payload: T
Returns void
- Defined in EventDispatcher.ts:136

register

register(listener: Listener<T>): number
Registers a listener. If the listener already exists, nothing changes and the original Id is returned.

Throws
ArgumentNullException if the listener is null.

Returns
The registered Id of the listener. Returns NaN if this has been disposed.
Parameters
- listener: Listener<T>
Returns number
Implementation of EventRegistry.register
- Defined in EventDispatcher.ts:85

remove

remove(id: number): undefined | Listener<T>
Removes a listener by Id.

Returns
The listener or undefined if not found.
Parameters
- id: number
  
  The registered Id of the listener.
Returns undefined | Listener<T>
Implementation of EventRegistry.remove
- Defined in EventDispatcher.ts:98

Generated using TypeDoc