ChangeStream | Documentation

Creates a new Change Stream instance. Normally created using {@link Collection#watch|Collection.watch()}.

Type Parameters

TSchema extends <internal>.Document = <internal>.Document
TChange extends <internal>.Document = ChangeStreamDocument<TSchema>

Hierarchy

TypedEventEmitter<ChangeStreamEvents<TSchema, TChange>>
- ChangeStream

Constructors

constructor

new ChangeStream<TSchema, TChange>(): ChangeStream<TSchema, TChange>

Inherited from TypedEventEmitter.constructor
- Defined in node_modules/@types/node/events.d.ts:11
Type Parameters
- TSchema extends <internal>.Document = <internal>.Document
- TChange extends <internal>.Document = ChangeStreamDocument<TSchema>
Returns ChangeStream<TSchema, TChange>

Methods

Static once

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

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

hasNext

hasNext(): Promise<boolean>
hasNext(callback: <internal>.Callback<boolean>): void

- Defined in node_modules/mongodb/mongodb.d.ts:1159
Check if there is any document still available in the Change Stream

deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Returns Promise<boolean>
- Defined in node_modules/mongodb/mongodb.d.ts:1161
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: <internal>.Callback<boolean>
Returns void

next(): Promise<TChange>
next(callback: <internal>.Callback<TChange>): void

- Defined in node_modules/mongodb/mongodb.d.ts:1163
Get the next available document from the Change Stream.

deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Returns Promise<TChange>
- Defined in node_modules/mongodb/mongodb.d.ts:1165
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: <internal>.Callback<TChange>
Returns void

tryNext

tryNext(): Promise<<internal>.Document>
tryNext(callback: <internal>.Callback<<internal>.Document>): void

- Defined in node_modules/mongodb/mongodb.d.ts:1169
Try to get the next available document from the Change Stream's cursor or null if an empty batch is returned

deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Returns Promise<<internal>.Document>
- Defined in node_modules/mongodb/mongodb.d.ts:1171
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: <internal>.Callback<<internal>.Document>
Returns void

[asyncIterator]

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

- Defined in node_modules/mongodb/mongodb.d.ts:1172
Returns AsyncGenerator<TChange, void, void>

close

close(): Promise<void>
close(callback: <internal>.Callback<any>): void

- Defined in node_modules/mongodb/mongodb.d.ts:1176
Close the Change Stream

deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Returns Promise<void>
- Defined in node_modules/mongodb/mongodb.d.ts:1178
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: <internal>.Callback<any>
Returns void

stream

stream(options?: CursorStreamOptions): <internal>.Readable & <internal>.AsyncIterable<TChange>

- Defined in node_modules/mongodb/mongodb.d.ts:1187
Return a modified Readable stream including a possible transform method.

NOTE: When using a Stream to process change stream events, the stream will NOT automatically resume in the case a resumable error is encountered.

throws
MongoChangeStreamError if the underlying cursor or the change stream is closed

Parameters
- Optional options: CursorStreamOptions
Returns <internal>.Readable & <internal>.AsyncIterable<TChange>

addListener

addListener<EventKey>(event: EventKey, listener: ChangeStreamEvents<TSchema, TChange>[EventKey]): ChangeStream<TSchema, TChange>
addListener(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ChangeStream<TSchema, TChange>
addListener(event: string | symbol, listener: GenericListener): ChangeStream<TSchema, TChange>

Inherited from TypedEventEmitter.addListener
- Defined in node_modules/mongodb/mongodb.d.ts:6481
Type Parameters
- EventKey extends "error" | "init" | "close" | "end" | "response" | "more" | "change" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents<TSchema, TChange>[EventKey]
Returns ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.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 ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.addListener
- Defined in node_modules/mongodb/mongodb.d.ts:6483
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema, TChange>

on

on<EventKey>(event: EventKey, listener: ChangeStreamEvents<TSchema, TChange>[EventKey]): ChangeStream<TSchema, TChange>
on(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ChangeStream<TSchema, TChange>
on(event: string | symbol, listener: GenericListener): ChangeStream<TSchema, TChange>

Inherited from TypedEventEmitter.on
- Defined in node_modules/mongodb/mongodb.d.ts:6484
Type Parameters
- EventKey extends "error" | "init" | "close" | "end" | "response" | "more" | "change" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents<TSchema, TChange>[EventKey]
Returns ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.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 ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.on
- Defined in node_modules/mongodb/mongodb.d.ts:6486
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema, TChange>

once

once<EventKey>(event: EventKey, listener: ChangeStreamEvents<TSchema, TChange>[EventKey]): ChangeStream<TSchema, TChange>
once(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ChangeStream<TSchema, TChange>
once(event: string | symbol, listener: GenericListener): ChangeStream<TSchema, TChange>

Inherited from TypedEventEmitter.once
- Defined in node_modules/mongodb/mongodb.d.ts:6487
Type Parameters
- EventKey extends "error" | "init" | "close" | "end" | "response" | "more" | "change" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents<TSchema, TChange>[EventKey]
Returns ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.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 ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.once
- Defined in node_modules/mongodb/mongodb.d.ts:6489
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema, TChange>

removeListener

removeListener<EventKey>(event: EventKey, listener: ChangeStreamEvents<TSchema, TChange>[EventKey]): ChangeStream<TSchema, TChange>
removeListener(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ChangeStream<TSchema, TChange>
removeListener(event: string | symbol, listener: GenericListener): ChangeStream<TSchema, TChange>

Inherited from TypedEventEmitter.removeListener
- Defined in node_modules/mongodb/mongodb.d.ts:6490
Type Parameters
- EventKey extends "error" | "init" | "close" | "end" | "response" | "more" | "change" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents<TSchema, TChange>[EventKey]
Returns ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.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 ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.removeListener
- Defined in node_modules/mongodb/mongodb.d.ts:6492
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema, TChange>

off

off<EventKey>(event: EventKey, listener: ChangeStreamEvents<TSchema, TChange>[EventKey]): ChangeStream<TSchema, TChange>
off(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ChangeStream<TSchema, TChange>
off(event: string | symbol, listener: GenericListener): ChangeStream<TSchema, TChange>

Inherited from TypedEventEmitter.off
- Defined in node_modules/mongodb/mongodb.d.ts:6493
Type Parameters
- EventKey extends "error" | "init" | "close" | "end" | "response" | "more" | "change" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents<TSchema, TChange>[EventKey]
Returns ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.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 ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.off
- Defined in node_modules/mongodb/mongodb.d.ts:6495
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema, TChange>

removeAllListeners

removeAllListeners<EventKey>(event?: string | symbol | EventKey): ChangeStream<TSchema, TChange>

Inherited from TypedEventEmitter.removeAllListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6496
Type Parameters
- EventKey extends "error" | "init" | "close" | "end" | "response" | "more" | "change" | "resumeTokenChanged"
Parameters
- Optional event: string | symbol | EventKey
Returns ChangeStream<TSchema, TChange>

listeners

listeners<EventKey>(event: string | symbol | EventKey): ChangeStreamEvents<TSchema, TChange>[EventKey][]

Inherited from TypedEventEmitter.listeners
- Defined in node_modules/mongodb/mongodb.d.ts:6497
Type Parameters
- EventKey extends "error" | "init" | "close" | "end" | "response" | "more" | "change" | "resumeTokenChanged"
Parameters
- event: string | symbol | EventKey
Returns ChangeStreamEvents<TSchema, TChange>[EventKey][]

rawListeners

rawListeners<EventKey>(event: string | symbol | EventKey): ChangeStreamEvents<TSchema, TChange>[EventKey][]

Inherited from TypedEventEmitter.rawListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6498
Type Parameters
- EventKey extends "error" | "init" | "close" | "end" | "response" | "more" | "change" | "resumeTokenChanged"
Parameters
- event: string | symbol | EventKey
Returns ChangeStreamEvents<TSchema, TChange>[EventKey][]

emit

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

Inherited from TypedEventEmitter.emit
- Defined in node_modules/mongodb/mongodb.d.ts:6499
Type Parameters
- EventKey extends "error" | "init" | "close" | "end" | "response" | "more" | "change" | "resumeTokenChanged"
Parameters
- event: symbol | EventKey
- Rest ...args: Parameters<ChangeStreamEvents<TSchema, TChange>[EventKey]>
Returns boolean

listenerCount

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

Inherited from TypedEventEmitter.listenerCount
- Defined in node_modules/mongodb/mongodb.d.ts:6500
Type Parameters
- EventKey extends "error" | "init" | "close" | "end" | "response" | "more" | "change" | "resumeTokenChanged"
Parameters
- type: string | symbol | EventKey
Returns number

prependListener

prependListener<EventKey>(event: EventKey, listener: ChangeStreamEvents<TSchema, TChange>[EventKey]): ChangeStream<TSchema, TChange>
prependListener(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ChangeStream<TSchema, TChange>
prependListener(event: string | symbol, listener: GenericListener): ChangeStream<TSchema, TChange>

Inherited from TypedEventEmitter.prependListener
- Defined in node_modules/mongodb/mongodb.d.ts:6501
Type Parameters
- EventKey extends "error" | "init" | "close" | "end" | "response" | "more" | "change" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents<TSchema, TChange>[EventKey]
Returns ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.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 ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.prependListener
- Defined in node_modules/mongodb/mongodb.d.ts:6503
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema, TChange>

prependOnceListener

prependOnceListener<EventKey>(event: EventKey, listener: ChangeStreamEvents<TSchema, TChange>[EventKey]): ChangeStream<TSchema, TChange>
prependOnceListener(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): ChangeStream<TSchema, TChange>
prependOnceListener(event: string | symbol, listener: GenericListener): ChangeStream<TSchema, TChange>

Inherited from TypedEventEmitter.prependOnceListener
- Defined in node_modules/mongodb/mongodb.d.ts:6504
Type Parameters
- EventKey extends "error" | "init" | "close" | "end" | "response" | "more" | "change" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents<TSchema, TChange>[EventKey]
Returns ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.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 ChangeStream<TSchema, TChange>
Inherited from TypedEventEmitter.prependOnceListener
- Defined in node_modules/mongodb/mongodb.d.ts:6506
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema, TChange>

eventNames

eventNames(): string[]

Inherited from TypedEventEmitter.eventNames
- Defined in node_modules/mongodb/mongodb.d.ts:6507
Returns string[]

getMaxListeners

getMaxListeners(): number

Inherited from TypedEventEmitter.getMaxListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6508
Returns number

setMaxListeners

setMaxListeners(n: number): ChangeStream<TSchema, TChange>

Inherited from TypedEventEmitter.setMaxListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6509
Parameters
- n: number
Returns ChangeStream<TSchema, TChange>

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

type: symbol

Optional streamOptions

streamOptions?: CursorStreamOptions

Events

Static Readonly RESPONSE

RESPONSE: "response"

Static Readonly MORE

MORE: "more"

Static Readonly INIT

INIT: "init"

Static Readonly CLOSE

CLOSE: "close"

Static Readonly CHANGE

CHANGE: "change"

Fired for each new matching change in the specified namespace. Attaching a change event listener to a Change Stream will switch the stream into flowing mode. Data will then be passed as soon as it is available.

Static Readonly END

END: "end"

Static Readonly ERROR

ERROR: "error"

Static Readonly RESUME_TOKEN_CHANGED

RESUME_TOKEN_CHANGED: "resumeTokenChanged"

Emitted each time the change stream stores a new resume token.

Accessors

resumeToken

get resumeToken(): unknown

- Defined in node_modules/mongodb/mongodb.d.ts:1157
The cached resume token that is used to resume after the most recently returned change.

Returns unknown

closed

get closed(): boolean

- Defined in node_modules/mongodb/mongodb.d.ts:1174
Is the cursor closed

Returns boolean

Type Parameters

TSchema extends <internal>.Document = <internal>.Document

TChange extends <internal>.Document = ChangeStreamDocument<TSchema>

Hierarchy

Index

Constructors

Methods

Properties

Events

Accessors

Constructors

constructor

Type Parameters

TSchema extends <internal>.Document = <internal>.Document

TChange extends <internal>.Document = ChangeStreamDocument<TSchema>

Returns ChangeStream<TSchema, TChange>

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

hasNext

Returns Promise<boolean>

Parameters

callback: <internal>.Callback<boolean>

Returns void

next

Returns Promise<TChange>

Parameters

callback: <internal>.Callback<TChange>

Returns void

tryNext

Returns Promise<<internal>.Document>

Parameters

callback: <internal>.Callback<<internal>.Document>

Returns void

[asyncIterator]

Returns AsyncGenerator<TChange, void, void>

close

Returns Promise<void>

Parameters

callback: <internal>.Callback<any>

Returns void

stream

Parameters

Optional options: CursorStreamOptions

Returns <internal>.Readable & <internal>.AsyncIterable<TChange>

addListener

Type Parameters

EventKey extends "error" | "init" | "close" | "end" | "response" | "more" | "change" | "resumeTokenChanged"

Parameters

event: EventKey

listener: ChangeStreamEvents<TSchema, TChange>[EventKey]

Returns ChangeStream<TSchema, TChange>

Parameters

event: CommonEvents

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

Parameters

eventName: string | symbol

listener: GenericListener

Returns void

Returns ChangeStream<TSchema, TChange>

Parameters

event: string | symbol

listener: GenericListener