Class EventEmitter

An extended event emitter:

Has an invoke method that iterates of the callback return value
Has a catcher that can handle callback exceptions

Hierarchy

EventEmitter

Implements

IEventEmitterExtendedMutable

Index

Constructors

constructor

Properties

__computed

Accessors

Methods

Constructors

constructor

new EventEmitter(init?: Init): EventEmitter

- Defined in lib/event/Emitter.ts:115
Parameters
- Optional init: Init
Returns EventEmitter

Properties

Static __computed

__computed: ICatcher = eventEmitterCatcher

Accessors

catcher

get catcher(): ICatcher | undefined
set catcher(value: ICatcher | undefined): void

- Defined in lib/event/Emitter.ts:77
Returns ICatcher | undefined
- Defined in lib/event/Emitter.ts:81
Parameters
- value: ICatcher | undefined
Returns void

maxListeners

get maxListeners(): number | undefined
set maxListeners(value: number | undefined): void

- Defined in lib/event/Emitter.ts:35
Returns number | undefined
- Defined in lib/event/Emitter.ts:39
Parameters
- value: number | undefined
Returns void

Static defaultCatcher

get defaultCatcher(): ICatcher
set defaultCatcher(value: ICatcher): void

- Defined in lib/event/Emitter.ts:105
Returns ICatcher
- Defined in lib/event/Emitter.ts:109
Parameters
- value: ICatcher
Returns void

Static defaultMaxListeners

get defaultMaxListeners(): number
set defaultMaxListeners(value: number): void

- Defined in lib/event/Emitter.ts:63
Returns number
- Defined in lib/event/Emitter.ts:67
Parameters
- value: number
Returns void

Methods

__@iterator

__@iterator(): IterableIterator<[Event, IterableIterator<IListener>]>

Implementation of IEventEmitterExtendedMutable.__@iterator
- Defined in lib/event/Emitter.ts:143
Returns IterableIterator<[Event, IterableIterator<IListener>]>

callbacks

callbacks(event: Event): IterableIterator<ICallback>

Implementation of IEventEmitterExtendedMutable.callbacks
- Defined in lib/event/Emitter.ts:155
Parameters
- event: Event
Returns IterableIterator<ICallback>

dispose

dispose(): this

Implementation of IEventEmitterExtendedMutable.dispose
- Defined in lib/event/Emitter.ts:172
Returns this

emit

emit<A>(event: Event, ...args: A): boolean

- Defined in lib/event/Emitter.ts:251
Type parameters
- A: Array<unknown>
Parameters
- event: Event
- Rest ...args: A
Returns boolean

entries

entries(): IterableIterator<[Event, IterableIterator<IListener>]>

Implementation of IEventEmitterExtendedMutable.entries
- Defined in lib/event/Emitter.ts:137
Returns IterableIterator<[Event, IterableIterator<IListener>]>

eventNames

eventNames(): Array<Event>

Implementation of IEventEmitterExtendedMutable.eventNames
- Defined in lib/event/Emitter.ts:151
Returns Array<Event>

getCatcher

getCatcher(): ICatcher

- Defined in lib/event/Emitter.ts:100
Returns ICatcher

getMaxListeners

getMaxListeners(): number

Implementation of IEventEmitterExtendedMutable.getMaxListeners
- Defined in lib/event/Emitter.ts:58
Returns number

invoke

invoke<A>(event: Event, ...args: A): IterableIterator<any>

- Defined in lib/event/Emitter.ts:266
Type parameters
- A: Array<unknown>
Parameters
- event: Event
- Rest ...args: A
Returns IterableIterator<any>

keys

keys(): IterableIterator<Event>

Implementation of IEventEmitterExtendedMutable.keys
- Defined in lib/event/Emitter.ts:127
Returns IterableIterator<Event>

listenerCount

listenerCount(event: Event): number

- Defined in lib/event/Emitter.ts:180
Parameters
- event: Event
Returns number

listeners

listeners(event: Event): Array<IListener>

- Defined in lib/event/Emitter.ts:176
Parameters
- event: Event
Returns Array<IListener>

names

names(): IterableIterator<Event>

Implementation of IEventEmitterExtendedMutable.names
- Defined in lib/event/Emitter.ts:147
Returns IterableIterator<Event>

off

off(event: "newListener" | "removeListener", listener: function): this
off(event: Event, listener: IListener): this

- Defined in lib/event/Emitter.ts:231
Parameters
- event: "newListener" | "removeListener"
- listener: function
  - - (event: Event, listener: IListener): void
    - Parameters
      - event: Event
      - listener: IListener
      Returns void
Returns this
- Defined in lib/event/Emitter.ts:235
Parameters
- event: Event
- listener: IListener
Returns this

on

on(event: "newListener" | "removeListener", listener: function): this
on(event: Event, listener: IListener | ICallback): this

- Defined in lib/event/Emitter.ts:206
Parameters
- event: "newListener" | "removeListener"
- listener: function
  - - (event: Event, listener: IListener): void
    - Parameters
      - event: Event
      - listener: IListener
      Returns void
Returns this
- Defined in lib/event/Emitter.ts:210
Parameters
- event: Event
- listener: IListener | ICallback
Returns this

once

once(event: "newListener" | "removeListener", listener: function): this
once(event: Event, listener: IListener): this

- Defined in lib/event/Emitter.ts:197
Parameters
- event: "newListener" | "removeListener"
- listener: function
  - - (event: Event, listener: IListener): void
    - Parameters
      - event: Event
      - listener: IListener
      Returns void
Returns this
- Defined in lib/event/Emitter.ts:201
Parameters
- event: Event
- listener: IListener
Returns this

removeAllListeners

removeAllListeners(event?: Event): this

- Defined in lib/event/Emitter.ts:163
Parameters
- Optional event: Event
Returns this

setCatcher

setCatcher(value: ICatcher): this

- Defined in lib/event/Emitter.ts:95
Parameters
- value: ICatcher
Returns this

setMaxListeners

setMaxListeners(value: number): this

Implementation of IEventEmitterExtendedMutable.setMaxListeners
- Defined in lib/event/Emitter.ts:53
Parameters
- value: number
Returns this

subscribe

subscribe(event: "newListener" | "removeListener", listener: function): IEventEmitterSubscriptionMutable
subscribe(event: Event, listener: IListener): IEventEmitterSubscriptionMutable

- Defined in lib/event/Emitter.ts:188
Parameters
- event: "newListener" | "removeListener"
- listener: function
  - - (event: Event, listener: IListener): void
    - Parameters
      - event: Event
      - listener: IListener
      Returns void
Returns IEventEmitterSubscriptionMutable
- Defined in lib/event/Emitter.ts:192
Parameters
- event: Event
- listener: IListener
Returns IEventEmitterSubscriptionMutable

values

values(): IterableIterator<IterableIterator<IListener>>

Implementation of IEventEmitterExtendedMutable.values
- Defined in lib/event/Emitter.ts:131
Returns IterableIterator<IterableIterator<IListener>>