Class EventDispatcher

Hierarchy

EventDispatcher

Implements

EventDispatcherInterface

Index

Constructors

Properties

injector instances listenerMap registeredClassTypes symbol

Methods

add buildFor dispatch fork getListeners getTokens hasListeners listen registerListener

Constructors

constructor

new EventDispatcher(injector?: InjectorContext): EventDispatcher
Parameters
- injector: InjectorContext = ...
Returns EventDispatcher
- Defined in packages/event/src/event.ts:170

Properties

injector

injector: InjectorContext = ...

`Protected` instances

instances: any[] = []

`Protected` listenerMap

listenerMap: Map<EventToken<any>, EventListenerContainerEntry[]> = ...

`Protected` registeredClassTypes

registeredClassTypes: Set<ClassType<any>> = ...

`Protected` symbol

symbol: symbol = ...

Methods

add

add(eventToken: EventToken<any>, listener: EventListenerContainerEntry): EventDispatcherUnsubscribe
Parameters
- eventToken: EventToken<any>
- listener: EventListenerContainerEntry
Returns EventDispatcherUnsubscribe
Implementation of EventDispatcherInterface.add
- Defined in packages/event/src/event.ts:189

`Protected` buildFor

buildFor(eventToken: EventToken<any>): undefined | EventDispatcherFn
Parameters
- eventToken: EventToken<any>
Returns undefined | EventDispatcherFn
- Defined in packages/event/src/event.ts:219

dispatch

dispatch<T>(eventToken: T, event?: EventOfEventToken<T>, injector?: InjectorContext): Promise<void>
Type Parameters
- T extends EventToken<any, T>
Parameters
- eventToken: T
- Optional event: EventOfEventToken<T>
- Optional injector: InjectorContext
Returns Promise<void>
Implementation of EventDispatcherInterface.dispatch
- Defined in packages/event/src/event.ts:256

fork

fork(): EventDispatcherInterface
Returns EventDispatcherInterface
Implementation of EventDispatcherInterface.fork
- Defined in packages/event/src/event.ts:268

getListeners

getListeners(eventToken: EventToken<any>): EventListenerContainerEntry[]
Parameters
- eventToken: EventToken<any>
Returns EventListenerContainerEntry[]
- Defined in packages/event/src/event.ts:209

getTokens

getTokens(): EventToken<any>[]
Returns EventToken<any>[]
- Defined in packages/event/src/event.ts:201

hasListeners

hasListeners(eventToken: EventToken<any>): boolean
Parameters
- eventToken: EventToken<any>
Returns boolean
Implementation of EventDispatcherInterface.hasListeners
- Defined in packages/event/src/event.ts:205

listen

listen<T, DEPS>(eventToken: T, callback: EventListenerCallback<T["event"]>, order?: number): EventDispatcherUnsubscribe
Type Parameters
- T extends EventToken<any, T>
- DEPS extends any[]
Parameters
- eventToken: T
- callback: EventListenerCallback<T["event"]>
- order: number = 0
Returns EventDispatcherUnsubscribe
Implementation of EventDispatcherInterface.listen
- Defined in packages/event/src/event.ts:185

registerListener

registerListener(listener: ClassType<any>, module: InjectorModule<any, InjectorModule<any, any>>): void
Parameters
- listener: ClassType<any>
- module: InjectorModule<any, InjectorModule<any, any>>
Returns void
- Defined in packages/event/src/event.ts:175

Generated using TypeDoc