TypedEventEmitter | Documentation

Typescript type safe event emitter

Type Parameters

Events extends EventsDescription

Hierarchy

<internal>.EventEmitter
- TypedEventEmitter

Constructors

constructor

new TypedEventEmitter<Events>(): TypedEventEmitter<Events>

Inherited from EventEmitter.constructor
- Defined in node_modules/@types/node/events.d.ts:11
Type Parameters
- Events extends EventsDescription
Returns TypedEventEmitter<Events>

Methods

Static once

once(emitter: <internal>.NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: <internal>.DOMEventTarget, event: string): Promise<any[]>

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

Static on

on(emitter: <internal>.EventEmitter, event: string): <internal>.AsyncIterableIterator<any>

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

Static listenerCount

listenerCount(emitter: <internal>.EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:18
deprecated
since v4.0.0

Parameters
- emitter: <internal>.EventEmitter
- event: string | symbol
Returns number

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 node_modules/mongodb/mongodb.d.ts:6481
Type Parameters
- EventKey extends string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.addListener
- Defined in node_modules/mongodb/mongodb.d.ts:6482
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 node_modules/mongodb/mongodb.d.ts:6483
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 node_modules/mongodb/mongodb.d.ts:6484
Type Parameters
- EventKey extends string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.on
- Defined in node_modules/mongodb/mongodb.d.ts:6485
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 node_modules/mongodb/mongodb.d.ts:6486
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 node_modules/mongodb/mongodb.d.ts:6487
Type Parameters
- EventKey extends string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.once
- Defined in node_modules/mongodb/mongodb.d.ts:6488
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 node_modules/mongodb/mongodb.d.ts:6489
Parameters
- event: string | symbol
- listener: GenericListener
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 node_modules/mongodb/mongodb.d.ts:6490
Type Parameters
- EventKey extends string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.removeListener
- Defined in node_modules/mongodb/mongodb.d.ts:6491
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 node_modules/mongodb/mongodb.d.ts:6492
Parameters
- event: string | symbol
- listener: GenericListener
Returns TypedEventEmitter<Events>

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 node_modules/mongodb/mongodb.d.ts:6493
Type Parameters
- EventKey extends string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.off
- Defined in node_modules/mongodb/mongodb.d.ts:6494
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 node_modules/mongodb/mongodb.d.ts:6495
Parameters
- event: string | symbol
- listener: GenericListener
Returns TypedEventEmitter<Events>

removeAllListeners

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

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6496
Type Parameters
- EventKey extends string | number | symbol
Parameters
- Optional event: string | symbol | EventKey
Returns TypedEventEmitter<Events>

listeners

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

Overrides EventEmitter.listeners
- Defined in node_modules/mongodb/mongodb.d.ts:6497
Type Parameters
- EventKey extends string | number | symbol
Parameters
- event: string | symbol | EventKey
Returns Events[EventKey][]

rawListeners

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

Overrides EventEmitter.rawListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6498
Type Parameters
- EventKey extends string | number | symbol
Parameters
- event: string | symbol | EventKey
Returns Events[EventKey][]

emit

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

Overrides EventEmitter.emit
- Defined in node_modules/mongodb/mongodb.d.ts:6499
Type Parameters
- EventKey extends string | number | symbol
Parameters
- event: symbol | EventKey
- Rest ...args: Parameters<Events[EventKey]>
Returns boolean

listenerCount

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

Overrides EventEmitter.listenerCount
- Defined in node_modules/mongodb/mongodb.d.ts:6500
Type Parameters
- EventKey extends string | number | symbol
Parameters
- type: string | symbol | EventKey
Returns number

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 node_modules/mongodb/mongodb.d.ts:6501
Type Parameters
- EventKey extends string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.prependListener
- Defined in node_modules/mongodb/mongodb.d.ts:6502
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 node_modules/mongodb/mongodb.d.ts:6503
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 node_modules/mongodb/mongodb.d.ts:6504
Type Parameters
- EventKey extends string | number | symbol
Parameters
- event: EventKey
- listener: Events[EventKey]
Returns TypedEventEmitter<Events>
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/mongodb/mongodb.d.ts:6505
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 node_modules/mongodb/mongodb.d.ts:6506
Parameters
- event: string | symbol
- listener: GenericListener
Returns TypedEventEmitter<Events>

eventNames

eventNames(): string[]

Overrides EventEmitter.eventNames
- Defined in node_modules/mongodb/mongodb.d.ts:6507
Returns string[]

getMaxListeners

getMaxListeners(): number

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6508
Returns number

setMaxListeners

setMaxListeners(n: number): TypedEventEmitter<Events>

Overrides EventEmitter.setMaxListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6509
Parameters
- n: number
Returns TypedEventEmitter<Events>

Properties

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.

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Type Parameters

Events extends EventsDescription

Hierarchy

Index

Constructors

Methods

Properties

Constructors

constructor

Type Parameters

Events extends EventsDescription

Returns TypedEventEmitter<Events>

Methods

Static once

Parameters

emitter: <internal>.NodeEventTarget

event: string | symbol

Returns Promise<any[]>

Parameters

emitter: <internal>.DOMEventTarget

event: string

Returns Promise<any[]>

Static on

Parameters

emitter: <internal>.EventEmitter

event: string

Returns <internal>.AsyncIterableIterator<any>

Static listenerCount

Parameters

emitter: <internal>.EventEmitter

event: string | symbol

Returns number

addListener

Type Parameters

EventKey extends 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>

on

Type Parameters

EventKey extends 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>

once

Type Parameters

EventKey extends string | number | symbol

Parameters

event: EventKey

listener: Events[EventKey]

Returns TypedEventEmitter<Events>

Parameters

event: CommonEvents

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