EventManager
Class EventManager
Hierarchy
EventEmitter
↳ EventManager
Index
Constructors
Properties
Methods
- addListener
- attach
- attachAt
- attachOnce
- detach
- emit
- eventNames
- getMaxListeners
- getSharedEventManager
- has
- listenerCount
- listeners
- off
- on
- once
- prependListener
- prependOnceListener
- rawListeners
- removeAllListeners
- removeListener
- setMaxListeners
- trigger
- listenerCount
Constructors
constructor
new EventManager(sharedEventManager?: EventManager): EventManager
Defined in Library/EventManager/EventManager.ts:11
Parameters:
| Name | Type | Default value |
|---|---|---|
Default value sharedEventManager | EventManager | null |
Returns: EventManager
Properties
Private hooks
hooks: object
Defined in Library/EventManager/EventManager.ts:11
Type declaration
Protected sharedEventManager
sharedEventManager: EventManager
Defined in Library/EventManager/EventManager.ts:9
Static defaultMaxListeners
defaultMaxListeners: number
Inherited from EventEmitter.defaultMaxListeners
**
Methods
addListener
addListener(event: * string | symbol*, listener: function): this
Inherited from EventEmitter.addListener
Overrides EventEmitter.addListener
**
Parameters:
| Name | Type |
|---|---|
| event | string | symbol |
| listener | function |
Returns: this
attach
attach(event: string, callback: Function, index?: number): this
Defined in Library/EventManager/EventManager.ts:69
Parameters:
| Name | Type |
|---|---|
| event | string |
| callback | Function |
Optional index | number |
Returns: this
attachAt
attachAt(index: number, event: string, callback: Function): this
Defined in Library/EventManager/EventManager.ts:81
Parameters:
| Name | Type |
|---|---|
| index | number |
| event | string |
| callback | Function |
Returns: this
attachOnce
attachOnce(eventName: string, callback: Function, index?: number): void
Defined in Library/EventManager/EventManager.ts:63
Parameters:
| Name | Type |
|---|---|
| eventName | string |
| callback | Function |
Optional index | number |
Returns: void
detach
detach(event: string, callback: Function): this
Defined in Library/EventManager/EventManager.ts:85
Parameters:
| Name | Type |
|---|---|
| event | string |
| callback | Function |
Returns: this
emit
emit(event: * string | symbol*, ...args: any[]): boolean
Inherited from EventEmitter.emit
Overrides EventEmitter.emit
**
Parameters:
| Name | Type |
|---|---|
| event | string | symbol |
Rest args | any[] |
Returns: boolean
eventNames
eventNames(): Array< string | symbol>
Inherited from EventEmitter.eventNames
Overrides EventEmitter.eventNames
**
Returns: Array< string | symbol>
getMaxListeners
getMaxListeners(): number
Inherited from EventEmitter.getMaxListeners
Overrides EventEmitter.getMaxListeners
**
Returns: number
getSharedEventManager
getSharedEventManager(): EventManager
Defined in Library/EventManager/EventManager.ts:105
Returns: EventManager
has
has(event: string, callback: Function): boolean
Defined in Library/EventManager/EventManager.ts:59
Parameters:
| Name | Type |
|---|---|
| event | string |
| callback | Function |
Returns: boolean
listenerCount
listenerCount(type: * string | symbol*): number
Inherited from EventEmitter.listenerCount
Overrides EventEmitter.listenerCount
**
Parameters:
| Name | Type |
|---|---|
| type | string | symbol |
Returns: number
listeners
listeners(event: * string | symbol*): Function[]
Inherited from EventEmitter.listeners
Overrides EventEmitter.listeners
**
Parameters:
| Name | Type |
|---|---|
| event | string | symbol |
Returns: Function[]
off
off(event: * string | symbol*, listener: function): this
Inherited from EventEmitter.off
Overrides EventEmitter.off
**
Parameters:
| Name | Type |
|---|---|
| event | string | symbol |
| listener | function |
Returns: this
on
on(event: * string | symbol*, listener: function): this
Inherited from EventEmitter.on
Overrides EventEmitter.on
**
Parameters:
| Name | Type |
|---|---|
| event | string | symbol |
| listener | function |
Returns: this
once
once(event: * string | symbol*, listener: function): this
Inherited from EventEmitter.once
Overrides EventEmitter.once
**
Parameters:
| Name | Type |
|---|---|
| event | string | symbol |
| listener | function |
Returns: this
prependListener
prependListener(event: * string | symbol*, listener: function): this
Inherited from EventEmitter.prependListener
Overrides EventEmitter.prependListener
**
Parameters:
| Name | Type |
|---|---|
| event | string | symbol |
| listener | function |
Returns: this
prependOnceListener
prependOnceListener(event: * string | symbol*, listener: function): this
Inherited from EventEmitter.prependOnceListener
Overrides EventEmitter.prependOnceListener
**
Parameters:
| Name | Type |
|---|---|
| event | string | symbol |
| listener | function |
Returns: this
rawListeners
rawListeners(event: * string | symbol*): Function[]
Inherited from EventEmitter.rawListeners
Overrides EventEmitter.rawListeners
**
Parameters:
| Name | Type |
|---|---|
| event | string | symbol |
Returns: Function[]
removeAllListeners
removeAllListeners(event?: * string | symbol*): this
Inherited from EventEmitter.removeAllListeners
Overrides EventEmitter.removeAllListeners
**
Parameters:
| Name | Type |
|---|---|
Optional event | string | symbol |
Returns: this
removeListener
removeListener(event: * string | symbol*, listener: function): this
Inherited from EventEmitter.removeListener
Overrides EventEmitter.removeListener
**
Parameters:
| Name | Type |
|---|---|
| event | string | symbol |
| listener | function |
Returns: this
setMaxListeners
setMaxListeners(n: number): this
Inherited from EventEmitter.setMaxListeners
Overrides EventEmitter.setMaxListeners
**
Parameters:
| Name | Type |
|---|---|
| n | number |
Returns: this
trigger
trigger(eventName: string, target: any, payload?: any): Promise<boolean>
Defined in Library/EventManager/EventManager.ts:19
Parameters:
| Name | Type |
|---|---|
| eventName | string |
| target | any |
Optional payload | any |
Returns: Promise<boolean>
Static listenerCount
listenerCount(emitter: EventEmitter, event: * string | symbol*): number
Inherited from EventEmitter.listenerCount
**
deprecated: since v4.0.0
Parameters:
| Name | Type |
|---|---|
| emitter | EventEmitter |
| event | string | symbol |
Returns: number