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:23
~~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:341
~~Type parameters~~类型参数
- EventKey: string | number | symbol
~~Parameters~~参数
- event: EventKey
- listener: Events[EventKey]
~~Returns~~返回TypedEventEmitter<Events>
Overrides EventEmitter.addListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:342
~~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:346
~~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:388
~~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:414
~~Returns~~返回string[]

getMaxListeners

getMaxListeners(): number

Overrides EventEmitter.getMaxListeners
- ~~Defined in~~ 定义位置：src/mongo_types.ts:415
~~Returns~~返回number

listenerCount

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

Overrides EventEmitter.listenerCount
- ~~Defined in~~ 定义位置：src/mongo_types.ts:393
~~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:380
~~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:369
~~Type parameters~~类型参数
- EventKey: string | number | symbol
~~Parameters~~参数
- event: EventKey
- listener: Events[EventKey]
~~Returns~~返回TypedEventEmitter<Events>
Overrides EventEmitter.off
- ~~Defined in~~ 定义位置：src/mongo_types.ts:370
~~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:374
~~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:348
~~Type parameters~~类型参数
- EventKey: string | number | symbol
~~Parameters~~参数
- event: EventKey
- listener: Events[EventKey]
~~Returns~~返回TypedEventEmitter<Events>
Overrides EventEmitter.on
- ~~Defined in~~ 定义位置：src/mongo_types.ts:349
~~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:353
~~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:355
~~Type parameters~~类型参数
- EventKey: string | number | symbol
~~Parameters~~参数
- event: EventKey
- listener: Events[EventKey]
~~Returns~~返回TypedEventEmitter<Events>
Overrides EventEmitter.once
- ~~Defined in~~ 定义位置：src/mongo_types.ts:356
~~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:360
~~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:397
~~Type parameters~~类型参数
- EventKey: string | number | symbol
~~Parameters~~参数
- event: EventKey
- listener: Events[EventKey]
~~Returns~~返回TypedEventEmitter<Events>
Overrides EventEmitter.prependListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:398
~~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:402
~~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:404
~~Type parameters~~类型参数
- EventKey: string | number | symbol
~~Parameters~~参数
- event: EventKey
- listener: Events[EventKey]
~~Returns~~返回TypedEventEmitter<Events>
Overrides EventEmitter.prependOnceListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:408
~~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:412
~~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:384
~~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:376
~~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:362
~~Type parameters~~类型参数
- EventKey: string | number | symbol
~~Parameters~~参数
- event: EventKey
- listener: Events[EventKey]
~~Returns~~返回TypedEventEmitter<Events>
Overrides EventEmitter.removeListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:363
~~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:367
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回TypedEventEmitter<Events>

setMaxListeners

setMaxListeners(n: number): TypedEventEmitter<Events>

Overrides EventEmitter.setMaxListeners
- ~~Defined in~~ 定义位置：src/mongo_types.ts:416
~~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