ChangeStream | mongodb (original) (raw)

[asyncIterator]

• [asyncIterator](): AsyncGenerator<TChange, void, void>

• Returns AsyncGenerator<TChange, void, void>

Optional[captureRejectionSymbol]

• [captureRejectionSymbol]<K>(error, event, ...args): void

• Type Parameters

  • K

Parameters

• error: Error
• event: string | symbol
• Rest...args: AnyRest

Returns void

addListener

• addListener<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends keyof ChangeStreamEvents<TSchema, TChange>

Returns this

• addListener(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• addListener(event, listener): this

• Returns this

close

• close(): Promise<void>

• Returns Promise<void>

emit

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

• Type Parameters

  • EventKey extends keyof ChangeStreamEvents<TSchema, TChange>

Parameters

• event: symbol | EventKey
• Rest...args: Parameters<ChangeStreamEvents<TSchema, TChange>[EventKey]>

Returns boolean

eventNames

• eventNames(): string[]

• Returns string[]

getMaxListeners

• getMaxListeners(): number

• Returns number

hasNext

• hasNext(): Promise<boolean>

• Returns Promise<boolean>

listenerCount

• listenerCount<EventKey>(type): number

• Type Parameters

  • EventKey extends keyof ChangeStreamEvents<TSchema, TChange>

Parameters

• type: string | symbol | EventKey

Returns number

listeners

• listeners<EventKey>(event): ChangeStreamEvents<TSchema, TChange>[EventKey][]

• Type Parameters

  • EventKey extends keyof ChangeStreamEvents<TSchema, TChange>

Parameters

• event: string | symbol | EventKey

Returns ChangeStreamEvents<TSchema, TChange>[EventKey][]

next

• next(): Promise<TChange>

• Returns Promise<TChange>

off

• off<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends keyof ChangeStreamEvents<TSchema, TChange>

Returns this

• off(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• off(event, listener): this

• Returns this

on

• on<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends keyof ChangeStreamEvents<TSchema, TChange>

Returns this

• on(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• on(event, listener): this

• Returns this

once

• once<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends keyof ChangeStreamEvents<TSchema, TChange>

Returns this

• once(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• once(event, listener): this

• Returns this

prependListener

• prependListener<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends keyof ChangeStreamEvents<TSchema, TChange>

Returns this

• prependListener(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• prependListener(event, listener): this

• Returns this

prependOnceListener

• prependOnceListener<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends keyof ChangeStreamEvents<TSchema, TChange>

Returns this

• prependOnceListener(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• prependOnceListener(event, listener): this

• Returns this

rawListeners

• rawListeners<EventKey>(event): ChangeStreamEvents<TSchema, TChange>[EventKey][]

• Type Parameters

  • EventKey extends keyof ChangeStreamEvents<TSchema, TChange>

Parameters

• event: string | symbol | EventKey

Returns ChangeStreamEvents<TSchema, TChange>[EventKey][]

removeAllListeners

• removeAllListeners<EventKey>(event?): this

• Type Parameters

  • EventKey extends keyof ChangeStreamEvents<TSchema, TChange>

Parameters

• Optionalevent: string | symbol | EventKey

Returns this

removeListener

• removeListener<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends keyof ChangeStreamEvents<TSchema, TChange>

Returns this

• removeListener(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• removeListener(event, listener): this

• Returns this

setMaxListeners

• setMaxListeners(n): this

• Returns this

stream

• stream(options?): Readable & AsyncIterable<TChange>

• Returns Readable & AsyncIterable<TChange>

tryNext

• tryNext(): Promise<null | TChange>

• Returns Promise<null | TChange>

StaticaddAbortListener

• addAbortListener(signal, resource): Disposable
• Experimental

Parameters

• signal: AbortSignal
• resource: ((event: Event) => void)
  * * (event): void
  * #### Returns void

Returns Disposable

Disposable that removes the abort listener.

StaticgetEventListeners

• getEventListeners(emitter, name): Function[]

• Parameters

  • emitter: EventEmitter<DefaultEventMap> | EventTarget
  • name: string | symbol

Returns Function[]

StaticgetMaxListeners

• getMaxListeners(emitter): number

• Parameters

  • emitter: EventEmitter<DefaultEventMap> | EventTarget

Returns number

StaticlistenerCount

• listenerCount(emitter, eventName): number

• Parameters

  • emitter: EventEmitter<DefaultEventMap>
  • eventName: string | symbol

Returns number

Staticon

• on(emitter, eventName, options?): AsyncIterator<any[], any, any>

• Parameters

  • emitter: EventEmitter<DefaultEventMap>
  • eventName: string | symbol
  • Optionaloptions: StaticEventEmitterIteratorOptions

Returns AsyncIterator<any[], any, any>

An AsyncIterator that iterates eventName events emitted by the emitter

• on(emitter, eventName, options?): AsyncIterator<any[], any, any>

• Parameters

  • emitter: EventTarget
  • eventName: string
  • Optionaloptions: StaticEventEmitterIteratorOptions

Returns AsyncIterator<any[], any, any>

Staticonce

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

• Parameters

  • emitter: EventEmitter<DefaultEventMap>
  • eventName: string | symbol
  • Optionaloptions: StaticEventEmitterOptions

Returns Promise<any[]>

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

• Parameters

  • emitter: EventTarget
  • eventName: string
  • Optionaloptions: StaticEventEmitterOptions

Returns Promise<any[]>

StaticsetMaxListeners

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

• Parameters

  • Optionaln: number
  • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

Returns void