TypedEventEmitter

Typescript type safe event emitter

Type parameters

Events: EventsDescription

Hierarchy

EventEmitter
- TypedEventEmitter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TypedEventEmitter<Events>(options?: EventEmitterOptions): TypedEventEmitter<Events>

Inherited from EventEmitter.constructor
- Defined in node_modules/@types/node/events.d.ts:22
Type parameters
- Events: EventsDescription
Parameters
- Optional options: EventEmitterOptions
Returns TypedEventEmitter<Events>

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

addListener<EventKey>(event: EventKey, listener: Events[EventKey]): TypedEventEmitter<Events>
addListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): TypedEventEmitter<Events>
addListener(event: string | symbol, listener: GenericListener): TypedEventEmitter<Events>

Overrides EventEmitter.addListener
- Defined in src/mongo_types.ts:342
Type parameters
- EventKey: string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.addListener
- Defined in src/mongo_types.ts:343
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns TypedEventEmitter<Events>
Overrides EventEmitter.addListener
- Defined in src/mongo_types.ts:347
Parameters
- event: string | symbol
- listener: GenericListener
Returns TypedEventEmitter<Events>

emit

emit<EventKey>(event: symbol | EventKey, ...args: Parameters<Events[EventKey]>): boolean

Overrides EventEmitter.emit
- Defined in src/mongo_types.ts:389
Type parameters
- EventKey: string | number | symbol
Parameters
- event: symbol | EventKey
- Rest ...args: Parameters<Events[EventKey]>
Returns boolean

eventNames

eventNames(): string[]

Overrides EventEmitter.eventNames
- Defined in src/mongo_types.ts:415
Returns string[]

getMaxListeners

getMaxListeners(): number

Overrides EventEmitter.getMaxListeners
- Defined in src/mongo_types.ts:416
Returns number

listenerCount

listenerCount<EventKey>(type: string | symbol | EventKey): number

Overrides EventEmitter.listenerCount
- Defined in src/mongo_types.ts:394
Type parameters
- EventKey: string | number | symbol
Parameters
- type: string | symbol | EventKey
Returns number

listeners

listeners<EventKey>(event: string | symbol | EventKey): Events[EventKey][]

Overrides EventEmitter.listeners
- Defined in src/mongo_types.ts:381
Type parameters
- EventKey: string | number | symbol
Parameters
- event: string | symbol | EventKey
Returns Events[EventKey][]

off

off<EventKey>(event: EventKey, listener: Events[EventKey]): TypedEventEmitter<Events>
off(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): TypedEventEmitter<Events>
off(event: string | symbol, listener: GenericListener): TypedEventEmitter<Events>

Overrides EventEmitter.off
- Defined in src/mongo_types.ts:370
Type parameters
- EventKey: string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.off
- Defined in src/mongo_types.ts:371
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns TypedEventEmitter<Events>
Overrides EventEmitter.off
- Defined in src/mongo_types.ts:375
Parameters
- event: string | symbol
- listener: GenericListener
Returns TypedEventEmitter<Events>

on

on<EventKey>(event: EventKey, listener: Events[EventKey]): TypedEventEmitter<Events>
on(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): TypedEventEmitter<Events>
on(event: string | symbol, listener: GenericListener): TypedEventEmitter<Events>

Overrides EventEmitter.on
- Defined in src/mongo_types.ts:349
Type parameters
- EventKey: string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.on
- Defined in src/mongo_types.ts:350
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns TypedEventEmitter<Events>
Overrides EventEmitter.on
- Defined in src/mongo_types.ts:354
Parameters
- event: string | symbol
- listener: GenericListener
Returns TypedEventEmitter<Events>

once

once<EventKey>(event: EventKey, listener: Events[EventKey]): TypedEventEmitter<Events>
once(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): TypedEventEmitter<Events>
once(event: string | symbol, listener: GenericListener): TypedEventEmitter<Events>

Overrides EventEmitter.once
- Defined in src/mongo_types.ts:356
Type parameters
- EventKey: string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.once
- Defined in src/mongo_types.ts:357
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns TypedEventEmitter<Events>
Overrides EventEmitter.once
- Defined in src/mongo_types.ts:361
Parameters
- event: string | symbol
- listener: GenericListener
Returns TypedEventEmitter<Events>

prependListener

prependListener<EventKey>(event: EventKey, listener: Events[EventKey]): TypedEventEmitter<Events>
prependListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): TypedEventEmitter<Events>
prependListener(event: string | symbol, listener: GenericListener): TypedEventEmitter<Events>

Overrides EventEmitter.prependListener
- Defined in src/mongo_types.ts:398
Type parameters
- EventKey: string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.prependListener
- Defined in src/mongo_types.ts:399
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns TypedEventEmitter<Events>
Overrides EventEmitter.prependListener
- Defined in src/mongo_types.ts:403
Parameters
- event: string | symbol
- listener: GenericListener
Returns TypedEventEmitter<Events>

prependOnceListener

prependOnceListener<EventKey>(event: EventKey, listener: Events[EventKey]): TypedEventEmitter<Events>
prependOnceListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): TypedEventEmitter<Events>
prependOnceListener(event: string | symbol, listener: GenericListener): TypedEventEmitter<Events>

Overrides EventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:405
Type parameters
- EventKey: string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:409
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns TypedEventEmitter<Events>
Overrides EventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:413
Parameters
- event: string | symbol
- listener: GenericListener
Returns TypedEventEmitter<Events>

rawListeners

rawListeners<EventKey>(event: string | symbol | EventKey): Events[EventKey][]

Overrides EventEmitter.rawListeners
- Defined in src/mongo_types.ts:385
Type parameters
- EventKey: string | number | symbol
Parameters
- event: string | symbol | EventKey
Returns Events[EventKey][]

removeAllListeners

removeAllListeners<EventKey>(event?: string | symbol | EventKey): TypedEventEmitter<Events>

Overrides EventEmitter.removeAllListeners
- Defined in src/mongo_types.ts:377
Type parameters
- EventKey: string | number | symbol
Parameters
- Optional event: string | symbol | EventKey
Returns TypedEventEmitter<Events>

removeListener

removeListener<EventKey>(event: EventKey, listener: Events[EventKey]): TypedEventEmitter<Events>
removeListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): TypedEventEmitter<Events>
removeListener(event: string | symbol, listener: GenericListener): TypedEventEmitter<Events>

Overrides EventEmitter.removeListener
- Defined in src/mongo_types.ts:363
Type parameters
- EventKey: string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.removeListener
- Defined in src/mongo_types.ts:364
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns TypedEventEmitter<Events>
Overrides EventEmitter.removeListener
- Defined in src/mongo_types.ts:368
Parameters
- event: string | symbol
- listener: GenericListener
Returns TypedEventEmitter<Events>

setMaxListeners

setMaxListeners(n: number): TypedEventEmitter<Events>

Overrides EventEmitter.setMaxListeners
- Defined in src/mongo_types.ts:417
Parameters
- n: number
Returns TypedEventEmitter<Events>

Static getEventListener

getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:34
Returns a list listener for a specific emitter event name.

Parameters
- emitter: DOMEventTarget | EventEmitter
- name: string | symbol
Returns Function[]

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:30
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: EventEmitter
- event: string
- Optional options: StaticEventEmitterOptions
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>

Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- emitter: NodeEventTarget
- event: string | symbol
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: DOMEventTarget
- event: string
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>

Type parameters

Events: EventsDescription

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

Events: EventsDescription

Parameters

Optional options: EventEmitterOptions

Returns TypedEventEmitter<Events>

Properties

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Type parameters

EventKey: string | number | symbol

Parameters

event: EventKey

listener: Events[EventKey]

Returns TypedEventEmitter<Events>

Parameters

event: CommonEvents

listener: (eventName: string | symbol, listener: GenericListener) => void

Parameters

eventName: string | symbol

listener: GenericListener

Returns void

Returns TypedEventEmitter<Events>

Parameters

event: string | symbol

listener: GenericListener

Returns TypedEventEmitter<Events>

emit

Type parameters

EventKey: string | number | symbol

Parameters

event: symbol | EventKey

Rest ...args: Parameters<Events[EventKey]>

Returns boolean

eventNames

Returns string[]

getMaxListeners

Returns number

listenerCount

Type parameters

EventKey: string | number | symbol

Parameters

type: string | symbol | EventKey

Returns number

listeners

Type parameters

EventKey: string | number | symbol

Parameters

event: string | symbol | EventKey

Returns Events[EventKey][]

off

Type parameters

EventKey: string | number | symbol

Parameters

event: EventKey

listener: Events[EventKey]

Returns TypedEventEmitter<Events>

Parameters

event: CommonEvents

listener: (eventName: string | symbol, listener: GenericListener) => void

Parameters

eventName: string | symbol

listener: GenericListener

Returns void

Returns TypedEventEmitter<Events>

Parameters

event: string | symbol

listener: GenericListener