TypedEventEmitter | mongodb (original) (raw)

• mongodb
• TypedEventEmitter

Class TypedEventEmitter

Type Parameters

• Events extends EventsDescription

Hierarchy

• EventEmitter
  • TypedEventEmitter
    * AbstractCursor
    * CancellationToken
    * ChangeStream
    * ClientSession
    * GridFSBucket
    * MongoClient

Index

Constructors

constructor

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

• Type Parameters

  • Events extends EventsDescription

Parameters

• Optional options: EventEmitterOptions

Returns TypedEventEmitter<Events>

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

Methods

addListener

• addListener<EventKey>(event, listener): TypedEventEmitter<Events>

• Type Parameters

  • EventKey extends string | number | symbol

Parameters

• event: EventKey

• listener: Events[EventKey]

Returns TypedEventEmitter<Events>

• addListener(event, listener): TypedEventEmitter<Events>

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns TypedEventEmitter<Events>

• addListener(event, listener): TypedEventEmitter<Events>

• Returns TypedEventEmitter<Events>

emit

• emit<EventKey>(event, ...args): boolean

• Type Parameters

  • EventKey extends string | number | symbol

Parameters

• event: symbol | EventKey

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

Returns boolean

eventNames

• eventNames(): string[]

• Returns string[]

getMaxListeners

• getMaxListeners(): number

• Returns number

listenerCount

• listenerCount<EventKey>(type): number

• Type Parameters

  • EventKey extends string | number | symbol

Parameters

• type: string | symbol | EventKey

Returns number

listeners

• listeners<EventKey>(event): Events[EventKey][]

• Type Parameters

  • EventKey extends string | number | symbol

Parameters

• event: string | symbol | EventKey

Returns Events[EventKey][]

off

• off<EventKey>(event, listener): TypedEventEmitter<Events>

• Type Parameters

  • EventKey extends string | number | symbol

Parameters

• event: EventKey

• listener: Events[EventKey]

Returns TypedEventEmitter<Events>

• off(event, listener): TypedEventEmitter<Events>

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns TypedEventEmitter<Events>

• off(event, listener): TypedEventEmitter<Events>

• Returns TypedEventEmitter<Events>

on

• on<EventKey>(event, listener): TypedEventEmitter<Events>

• Type Parameters

  • EventKey extends string | number | symbol

Parameters

• event: EventKey

• listener: Events[EventKey]

Returns TypedEventEmitter<Events>

• on(event, listener): TypedEventEmitter<Events>

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns TypedEventEmitter<Events>

• on(event, listener): TypedEventEmitter<Events>

• Returns TypedEventEmitter<Events>

once

• once<EventKey>(event, listener): TypedEventEmitter<Events>

• Type Parameters

  • EventKey extends string | number | symbol

Parameters

• event: EventKey

• listener: Events[EventKey]

Returns TypedEventEmitter<Events>

• once(event, listener): TypedEventEmitter<Events>

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns TypedEventEmitter<Events>

• once(event, listener): TypedEventEmitter<Events>

• Returns TypedEventEmitter<Events>

prependListener

• prependListener<EventKey>(event, listener): TypedEventEmitter<Events>

• Type Parameters

  • EventKey extends string | number | symbol

Parameters

• event: EventKey

• listener: Events[EventKey]

Returns TypedEventEmitter<Events>

• prependListener(event, listener): TypedEventEmitter<Events>

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns TypedEventEmitter<Events>

• prependListener(event, listener): TypedEventEmitter<Events>

• Returns TypedEventEmitter<Events>

prependOnceListener

• prependOnceListener<EventKey>(event, listener): TypedEventEmitter<Events>

• Type Parameters

  • EventKey extends string | number | symbol

Parameters

• event: EventKey

• listener: Events[EventKey]

Returns TypedEventEmitter<Events>

• prependOnceListener(event, listener): TypedEventEmitter<Events>

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns TypedEventEmitter<Events>

• prependOnceListener(event, listener): TypedEventEmitter<Events>

• Returns TypedEventEmitter<Events>

rawListeners

• rawListeners<EventKey>(event): Events[EventKey][]

• Type Parameters

  • EventKey extends string | number | symbol

Parameters

• event: string | symbol | EventKey

Returns Events[EventKey][]

removeAllListeners

• removeAllListeners<EventKey>(event?): TypedEventEmitter<Events>

• Type Parameters

  • EventKey extends string | number | symbol

Parameters

• Optional event: string | symbol | EventKey

Returns TypedEventEmitter<Events>

removeListener

• removeListener<EventKey>(event, listener): TypedEventEmitter<Events>

• Type Parameters

  • EventKey extends string | number | symbol

Parameters

• event: EventKey

• listener: Events[EventKey]

Returns TypedEventEmitter<Events>

• removeListener(event, listener): TypedEventEmitter<Events>

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns TypedEventEmitter<Events>

• removeListener(event, listener): TypedEventEmitter<Events>

• Returns TypedEventEmitter<Events>

setMaxListeners

• setMaxListeners(n): TypedEventEmitter<Events>

• Parameters

  • n: number

Returns TypedEventEmitter<Events>

Static getEventListeners

• getEventListeners(emitter, name): Function[]

• Parameters

  • emitter: EventEmitter | _DOMEventTarget

  • name: string | symbol

Returns Function[]

Static listenerCount

• listenerCount(emitter, eventName): number

• Parameters

  • emitter: EventEmitter

  • eventName: string | symbol

Returns number

Static on

• on(emitter, eventName, options?): AsyncIterableIterator<any>

• Parameters

  • emitter: EventEmitter

  • eventName: string

  • Optional options: StaticEventEmitterOptions

Returns AsyncIterableIterator<any>

that iterates eventName events emitted by the emitter

Static once

• once(emitter, eventName, options?): Promise<any[]>

• Parameters

  • emitter: _NodeEventTarget

  • eventName: string | symbol

  • Optional options: StaticEventEmitterOptions

Returns Promise<any[]>

• once(emitter, eventName, options?): Promise<any[]>

• Parameters

  • emitter: _DOMEventTarget

  • eventName: string

  • Optional options: StaticEventEmitterOptions

Returns Promise<any[]>

Static setMaxListeners

• setMaxListeners(n?, ...eventTargets): void

• Parameters

  • Optional n: number

  • Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]

Returns void