ChangeStream | mongodb

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

Type parameters

TSchema: Document = Document

Hierarchy

TypedEventEmitter<ChangeStreamEvents>
- ChangeStream

Index

Constructors

constructor

Events

Properties

Accessors

Constructors

constructor

new ChangeStream<TSchema>(parent: OperationParent, pipeline?: Document[], options?: ChangeStreamOptions): ChangeStream<TSchema>

Overrides TypedEventEmitter.constructor
- Defined in src/change_stream.ts:237
internal

Type parameters
- TSchema: Document = Document
Parameters
- parent: OperationParent
  
  The parent object that created this change stream
- pipeline: Document[] = []
  
  An array of aggregation pipeline stages through which to pass change stream documents
- options: ChangeStreamOptions = {}
Returns ChangeStream<TSchema>

Events

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 CLOSE

CLOSE: "close" = ...

Static Readonly END

END: "end" = ...

Static Readonly ERROR

ERROR: "error" = ...

Static Readonly INIT

INIT: "init" = ...

Static Readonly MORE

MORE: "more" = ...

Static Readonly RESPONSE

RESPONSE: "response" = ...

Static Readonly RESUME_TOKEN_CHANGED

RESUME_TOKEN_CHANGED: "resumeTokenChanged" = ...

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

Properties

[kClosed]

[kClosed]: boolean

internal

Optional [kCursorStream]

[kCursorStream]: Readable

internal

[kMode]

[kMode]: false | "iterator" | "emitter"

internal

[kResumeQueue]

[kResumeQueue]: Denque<any>

internal

Optional cursor

cursor: ChangeStreamCursor<TSchema>

internal

pipeline

pipeline: Document[]

Optional streamOptions

streamOptions: CursorStreamOptions

type

type: symbol

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.

Accessors

closed

get closed(): boolean

- Defined in src/change_stream.ts:339
Is the cursor closed

Returns boolean

cursorStream

get cursorStream(): undefined | Readable

- Defined in src/change_stream.ts:296
internal

Returns undefined | Readable

resumeToken

get resumeToken(): unknown

- Defined in src/change_stream.ts:301
The cached resume token that is used to resume after the most recently returned change.

Returns unknown

Methods

addListener

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

Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:342
Type parameters
- EventKey: "close" | "error" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents[EventKey]
Returns ChangeStream<TSchema>
Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:343
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>
Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:347
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema>

close

close(callback?: Callback<any>): void | Promise<void>

- Defined in src/change_stream.ts:344
Close the Change Stream

Parameters
- Optional callback: Callback<any>
Returns void | Promise<void>

emit

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

Inherited from TypedEventEmitter.emit
- Defined in src/mongo_types.ts:389
Type parameters
- EventKey: "close" | "error" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"
Parameters
- event: symbol | EventKey
- Rest ...args: Parameters<ChangeStreamEvents[EventKey]>
Returns boolean

eventNames

eventNames(): string[]

Inherited from TypedEventEmitter.eventNames
- Defined in src/mongo_types.ts:415
Returns string[]

getMaxListeners

getMaxListeners(): number

Inherited from TypedEventEmitter.getMaxListeners
- Defined in src/mongo_types.ts:416
Returns number

hasNext

hasNext(callback?: Callback<any>): void | Promise<void>

- Defined in src/change_stream.ts:306
Check if there is any document still available in the Change Stream

Parameters
- Optional callback: Callback<any>
Returns void | Promise<void>

listenerCount

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

Inherited from TypedEventEmitter.listenerCount
- Defined in src/mongo_types.ts:394
Type parameters
- EventKey: "close" | "error" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"
Parameters
- type: string | symbol | EventKey
Returns number

listeners

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

Inherited from TypedEventEmitter.listeners
- Defined in src/mongo_types.ts:381
Type parameters
- EventKey: "close" | "error" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"
Parameters
- event: string | symbol | EventKey
Returns ChangeStreamEvents[EventKey][]

next(): Promise<ChangeStreamDocument<TSchema>>
next(callback: Callback<ChangeStreamDocument<TSchema>>): void

- Defined in src/change_stream.ts:317
Get the next available document from the Change Stream.

Returns Promise<ChangeStreamDocument<TSchema>>
- Defined in src/change_stream.ts:318
Parameters
- callback: Callback<ChangeStreamDocument<TSchema>>
Returns void

off

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

Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:370
Type parameters
- EventKey: "close" | "error" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents[EventKey]
Returns ChangeStream<TSchema>
Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:371
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>
Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:375
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema>

on

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

Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:349
Type parameters
- EventKey: "close" | "error" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents[EventKey]
Returns ChangeStream<TSchema>
Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:350
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>
Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:354
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema>

once

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

Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:356
Type parameters
- EventKey: "close" | "error" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents[EventKey]
Returns ChangeStream<TSchema>
Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:357
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>
Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:361
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema>

prependListener

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

Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:398
Type parameters
- EventKey: "close" | "error" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents[EventKey]
Returns ChangeStream<TSchema>
Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:399
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>
Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:403
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema>

prependOnceListener

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

Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:405
Type parameters
- EventKey: "close" | "error" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents[EventKey]
Returns ChangeStream<TSchema>
Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:409
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>
Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:413
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema>

rawListeners

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

Inherited from TypedEventEmitter.rawListeners
- Defined in src/mongo_types.ts:385
Type parameters
- EventKey: "close" | "error" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"
Parameters
- event: string | symbol | EventKey
Returns ChangeStreamEvents[EventKey][]

removeAllListeners

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

Inherited from TypedEventEmitter.removeAllListeners
- Defined in src/mongo_types.ts:377
Type parameters
- EventKey: "close" | "error" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"
Parameters
- Optional event: string | symbol | EventKey
Returns ChangeStream<TSchema>

removeListener

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

Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:363
Type parameters
- EventKey: "close" | "error" | "response" | "more" | "init" | "change" | "end" | "resumeTokenChanged"
Parameters
- event: EventKey
- listener: ChangeStreamEvents[EventKey]
Returns ChangeStream<TSchema>
Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:364
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>
Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:368
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStream<TSchema>

setMaxListeners

setMaxListeners(n: number): ChangeStream<TSchema>

Inherited from TypedEventEmitter.setMaxListeners
- Defined in src/mongo_types.ts:417
Parameters
- n: number
Returns ChangeStream<TSchema>

stream

stream(options?: CursorStreamOptions): Readable

- Defined in src/change_stream.ts:365
Return a modified Readable stream including a possible transform method.

throws

MongoDriverError if this.cursor is undefined

Parameters
- Optional options: CursorStreamOptions
Returns Readable

tryNext

tryNext(): Promise<null | Document>
tryNext(callback: Callback<null | Document>): void

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

Returns Promise<null | Document>
- Defined in src/change_stream.ts:375
Parameters
- callback: Callback<null | Document>
Returns void

Static getEventListener

getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

Inherited from TypedEventEmitter.getEventListener
- 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 TypedEventEmitter.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 TypedEventEmitter.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 TypedEventEmitter.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 TypedEventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: DOMEventTarget
- event: string
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>

Type parameters

TSchema: Document = Document

Hierarchy

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

constructor

Type parameters

TSchema: Document = Document

Parameters

parent: OperationParent

pipeline: Document[] = []

options: ChangeStreamOptions = {}

Returns ChangeStream<TSchema>

Events

Static Readonly CHANGE

Static Readonly CLOSE

Static Readonly END

Static Readonly ERROR

Static Readonly INIT

Static Readonly MORE

Static Readonly RESPONSE

Static Readonly RESUME_TOKEN_CHANGED

Properties

[kClosed]

Optional [kCursorStream]

[kMode]

[kResumeQueue]

Optional cursor

namespace

options

parent

pipeline

Optional streamOptions

type

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors

closed

Returns boolean

cursorStream

Returns undefined | Readable

resumeToken

Returns unknown

Methods

addListener

Type parameters

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

Parameters

event: EventKey

listener: ChangeStreamEvents[EventKey]

Returns ChangeStream<TSchema>

Parameters

event: CommonEvents

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

Parameters

eventName: string | symbol

listener: GenericListener

Returns void

Returns ChangeStream<TSchema>

Parameters

event: string | symbol

listener: GenericListener

Returns ChangeStream<TSchema>

close

Parameters

Optional callback: Callback<any>

Returns void | Promise<void>

emit

Type parameters

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

Parameters

event: symbol | EventKey

Rest ...args: Parameters<ChangeStreamEvents[EventKey]>