Class EventEmitter<EventTypes>

Minimal EventEmitter interface that is molded against the Node.js EventEmitter interface.

Type parameters

EventTypes: string | symbol = string | symbol

Hierarchy

EventEmitter

Index

Constructors

constructor

Properties

prefixed

Methods

Constructors

constructor

new EventEmitter<EventTypes>(): EventEmitter<EventTypes>

Type parameters
- EventTypes: string | symbol = string | symbol
Returns EventEmitter<EventTypes>

Properties

Static prefixed

prefixed: string | boolean

Methods

addListener

addListener(event: EventTypes, fn: ListenerFn, context?: any): EventEmitter<EventTypes>

- Defined in source/node_modules/eventemitter3/index.d.ts:33
Parameters
- event: EventTypes
- fn: ListenerFn
- Optional context: any
Returns EventEmitter<EventTypes>

emit

emit(event: EventTypes, ...args: any[]): boolean

- Defined in source/node_modules/eventemitter3/index.d.ts:27
Calls each of the listeners registered for a given event.

Parameters
- event: EventTypes
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): EventTypes[]

- Defined in source/node_modules/eventemitter3/index.d.ts:12
Return an array listing the events for which the emitter has registered listeners.

Returns EventTypes[]

listenerCount

listenerCount(event: EventTypes): number

- Defined in source/node_modules/eventemitter3/index.d.ts:22
Return the number of listeners listening to a given event.

Parameters
- event: EventTypes
Returns number

listeners

listeners(event: EventTypes): ListenerFn[]

- Defined in source/node_modules/eventemitter3/index.d.ts:17
Return the listeners registered for a given event.

Parameters
- event: EventTypes
Returns ListenerFn[]

off

off(event: EventTypes, fn?: ListenerFn, context?: any, once?: boolean): EventEmitter<EventTypes>

- Defined in source/node_modules/eventemitter3/index.d.ts:44
Parameters
- event: EventTypes
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns EventEmitter<EventTypes>

on

on(event: EventTypes, fn: ListenerFn, context?: any): EventEmitter<EventTypes>

- Defined in source/node_modules/eventemitter3/index.d.ts:32
Add a listener for a given event.

Parameters
- event: EventTypes
- fn: ListenerFn
- Optional context: any
Returns EventEmitter<EventTypes>

once

once(event: EventTypes, fn: ListenerFn, context?: any): EventEmitter<EventTypes>

- Defined in source/node_modules/eventemitter3/index.d.ts:38
Add a one-time listener for a given event.

Parameters
- event: EventTypes
- fn: ListenerFn
- Optional context: any
Returns EventEmitter<EventTypes>

removeAllListeners

removeAllListeners(event?: EventTypes): EventEmitter<EventTypes>

- Defined in source/node_modules/eventemitter3/index.d.ts:49
Remove all listeners, or those of the specified event.

Parameters
- Optional event: EventTypes
Returns EventEmitter<EventTypes>

removeListener

removeListener(event: EventTypes, fn?: ListenerFn, context?: any, once?: boolean): EventEmitter<EventTypes>

- Defined in source/node_modules/eventemitter3/index.d.ts:43
Remove the listeners of a given event.

Parameters
- event: EventTypes
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns EventEmitter<EventTypes>

Generated using TypeDoc