ChangeStreamCursor

internal

Type parameters

TSchema: Document = Document

Hierarchy

AbstractCursor<ChangeStreamDocument<TSchema>, ChangeStreamEvents>
- ChangeStreamCursor

Index

Constructors

constructor

Events

Accessors

Constructors

constructor

new ChangeStreamCursor<TSchema>(topology: Topology, namespace: MongoDBNamespace, pipeline?: Document[], options?: ChangeStreamCursorOptions): ChangeStreamCursor<TSchema>

Overrides AbstractCursor.constructor
- Defined in src/change_stream.ts:407
Type parameters
- TSchema: Document = Document
Parameters
- topology: Topology
- namespace: MongoDBNamespace
- pipeline: Document[] = []
- options: ChangeStreamCursorOptions = {}
Returns ChangeStreamCursor<TSchema>

Events

Static Readonly CLOSE

CLOSE: "close" = ...

Properties

[kClosed]

[kClosed]: boolean

internal

[kDocuments]

[kDocuments]: ChangeStreamDocument<TSchema>[]

internal

Optional [kId]

[kId]: Long

internal

[kInitialized]

[kInitialized]: boolean

internal

[kKilled]

[kKilled]: boolean

internal

[kNamespace]

[kNamespace]: MongoDBNamespace

internal

[kOptions]

[kOptions]: InternalAbstractCursorOptions

internal

Optional [kServer]

[kServer]: Server

internal

Optional [kSession]

[kSession]: ClientSession

internal

[kTopology]

[kTopology]: Topology

internal

Optional [kTransform]

[kTransform]: (doc: ChangeStreamDocument<TSchema>) => Document

Type declaration

- (doc: ChangeStreamDocument<TSchema>): Document
- Parameters
  - doc: ChangeStreamDocument<TSchema>
  Returns Document

_resumeToken

_resumeToken: unknown

Optional hasReceived

hasReceived: boolean

options

options: ChangeStreamCursorOptions

pipeline

pipeline: Document[]

Optional postBatchResumeToken

postBatchResumeToken: unknown

resumeAfter

resumeAfter: unknown

startAfter

startAfter: unknown

Optional startAtOperationTime

startAtOperationTime: Timestamp

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/cursor/abstract_cursor.ts:206
Returns boolean

cursorOptions

get cursorOptions(): InternalAbstractCursorOptions

- Defined in src/cursor/abstract_cursor.ts:202
internal

Returns InternalAbstractCursorOptions

id

get id(): undefined | Long

- Defined in src/cursor/abstract_cursor.ts:166
Returns undefined | Long

killed

get killed(): boolean

- Defined in src/cursor/abstract_cursor.ts:210
Returns boolean

namespace

get namespace(): MongoDBNamespace

- Defined in src/cursor/abstract_cursor.ts:180
Returns MongoDBNamespace

readConcern

get readConcern(): undefined | ReadConcern

- Defined in src/cursor/abstract_cursor.ts:188
Returns undefined | ReadConcern

readPreference

get readPreference(): ReadPreference

- Defined in src/cursor/abstract_cursor.ts:184
Returns ReadPreference

resumeOptions

get resumeOptions(): ResumeOptions

- Defined in src/change_stream.ts:438
Returns ResumeOptions

resumeToken

get resumeToken(): unknown
set resumeToken(token: unknown): void

- Defined in src/change_stream.ts:434
Returns unknown
- Defined in src/change_stream.ts:429
Parameters
- token: unknown
Returns void

server

get server(): undefined | Server

- Defined in src/cursor/abstract_cursor.ts:176
internal

Returns undefined | Server

session

get session(): undefined | ClientSession
set session(clientSession: undefined | ClientSession): void

- Defined in src/cursor/abstract_cursor.ts:193
internal

Returns undefined | ClientSession
- Defined in src/cursor/abstract_cursor.ts:197
Parameters
- clientSession: undefined | ClientSession
Returns void

topology

get topology(): Topology

- Defined in src/cursor/abstract_cursor.ts:171
internal

Returns Topology

Methods

[asyncIterator]

[asyncIterator](): AsyncIterator<null | ChangeStreamDocument<TSchema>, any, undefined>

Inherited from AbstractCursor.[asyncIterator]
- Defined in src/cursor/abstract_cursor.ts:224
Returns AsyncIterator<null | ChangeStreamDocument<TSchema>, any, undefined>

_getMore

_getMore(batchSize: number, callback: Callback<any>): void

Overrides AbstractCursor._getMore
- Defined in src/change_stream.ts:525
Parameters
- batchSize: number
- callback: Callback<any>
Returns void

_initialize

_initialize(session: ClientSession, callback: Callback<ExecutionResult>): void

Overrides AbstractCursor._initialize
- Defined in src/change_stream.ts:489
Parameters
- session: ClientSession
- callback: Callback<ExecutionResult>
Returns void

_processBatch

_processBatch(batchName: string, response?: Document): void

- Defined in src/change_stream.ts:472
Parameters
- batchName: string
- Optional response: Document
Returns void

addCursorFlag

addCursorFlag(flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial", value: boolean): ChangeStreamCursor<TSchema>

Inherited from AbstractCursor.addCursorFlag
- Defined in src/cursor/abstract_cursor.ts:462
Add a cursor flag to the cursor

Parameters
- flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial"
  
  The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
- value: boolean
  
  The flag boolean value.
Returns ChangeStreamCursor<TSchema>

addListener

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

Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.addListener
- Defined in src/mongo_types.ts:347
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStreamCursor<TSchema>

batchSize

batchSize(value: number): ChangeStreamCursor<TSchema>

Inherited from AbstractCursor.batchSize
- Defined in src/cursor/abstract_cursor.ts:561
Set the batch size for the cursor.

Parameters
- value: number
  
  The number of documents to return per batch. See find command documentation.
Returns ChangeStreamCursor<TSchema>

bufferedCount

bufferedCount(): number

Inherited from AbstractCursor.bufferedCount
- Defined in src/cursor/abstract_cursor.ts:215
Returns current buffered documents length

Returns number

cacheResumeToken

cacheResumeToken(resumeToken: unknown): void

- Defined in src/change_stream.ts:463
Parameters
- resumeToken: unknown
Returns void

clone

clone(): AbstractCursor<ChangeStreamDocument<TSchema>, AbstractCursorEvents>

Overrides AbstractCursor.clone
- Defined in src/change_stream.ts:483
Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance

Returns AbstractCursor<ChangeStreamDocument<TSchema>, AbstractCursorEvents>

close

close(): void
close(callback: Callback<any>): void
close(options: CursorCloseOptions): Promise<void>
close(options: CursorCloseOptions, callback: Callback<any>): void

Inherited from AbstractCursor.close
- Defined in src/cursor/abstract_cursor.ts:360
Returns void
Inherited from AbstractCursor.close
- Defined in src/cursor/abstract_cursor.ts:361
Parameters
- callback: Callback<any>
Returns void
Inherited from AbstractCursor.close
- Defined in src/cursor/abstract_cursor.ts:362
Parameters
- options: CursorCloseOptions
Returns Promise<void>
Inherited from AbstractCursor.close
- Defined in src/cursor/abstract_cursor.ts:363
Parameters
- options: CursorCloseOptions
- callback: Callback<any>
Returns void

emit

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

Inherited from AbstractCursor.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 AbstractCursor.eventNames
- Defined in src/mongo_types.ts:415
Returns string[]

forEach

forEach<T>(iterator: (doc: T) => boolean | void): Promise<void>
forEach<T>(iterator: (doc: T) => boolean | void, callback: Callback<void>): void

Inherited from AbstractCursor.forEach
- Defined in src/cursor/abstract_cursor.ts:315
Iterates over all the documents for this cursor using the iterator, callback pattern.

Type parameters
- T = ChangeStreamDocument<TSchema>
Parameters
- iterator: (doc: T) => boolean | void
  
  The iteration callback.
  - - (doc: T): boolean | void
    - Parameters
      - doc: T
      Returns boolean | void
Returns Promise<void>
Inherited from AbstractCursor.forEach
- Defined in src/cursor/abstract_cursor.ts:316
Type parameters
- T = ChangeStreamDocument<TSchema>
Parameters
- iterator: (doc: T) => boolean | void
  - - (doc: T): boolean | void
    - Parameters
      - doc: T
      Returns boolean | void
- callback: Callback<void>
Returns void

getMaxListeners

getMaxListeners(): number

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

hasNext

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

Inherited from AbstractCursor.hasNext
- Defined in src/cursor/abstract_cursor.ts:254
Returns Promise<boolean>
Inherited from AbstractCursor.hasNext
- Defined in src/cursor/abstract_cursor.ts:255
Parameters
- callback: Callback<boolean>
Returns void

listenerCount

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

Inherited from AbstractCursor.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 AbstractCursor.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][]

map

map<T>(transform: (doc: ChangeStreamDocument<TSchema>) => T): AbstractCursor<T, AbstractCursorEvents>

Inherited from AbstractCursor.map
- Defined in src/cursor/abstract_cursor.ts:494
Map all documents using the provided function If there is a transform set on the cursor, that will be called first and the result passed to this function's transform.
remarks

NOTE: adding a transform changes the return type of the iteration of this cursor, it does not return a new instance of a cursor. This means when calling map, you should always assign the result to a new variable. Take note of the following example:

example
```
const cursor: FindCursor<Document> = coll.find();
const mappedCursor: FindCursor<number> = cursor.map(doc => Object.keys(doc).length);
const keyCounts: number[] = await mappedCursor.toArray(); // cursor.toArray() still returns Document[]
```
Type parameters
- T = any
Parameters
- transform: (doc: ChangeStreamDocument<TSchema>) => T
  
  The mapping transformation method.
  - - (doc: ChangeStreamDocument<TSchema>): T
    - Parameters
      - doc: ChangeStreamDocument<TSchema>
      Returns T
Returns AbstractCursor<T, AbstractCursorEvents>

maxTimeMS

maxTimeMS(value: number): ChangeStreamCursor<TSchema>

Inherited from AbstractCursor.maxTimeMS
- Defined in src/cursor/abstract_cursor.ts:546
Set a maxTimeMS on the cursor query, allowing for hard timeout limits on queries (Only supported on MongoDB 2.6 or higher)

Parameters
- value: number
  
  Number of milliseconds to wait before aborting the query.
Returns ChangeStreamCursor<TSchema>

next<T>(): Promise<null | T>
next<T>(callback: Callback<null | T>): void

Inherited from AbstractCursor.next
- Defined in src/cursor/abstract_cursor.ts:282
Get the next available document from the cursor, returns null if no more documents are available.

Type parameters
- T = ChangeStreamDocument<TSchema>
Returns Promise<null | T>
Inherited from AbstractCursor.next
- Defined in src/cursor/abstract_cursor.ts:283
Type parameters
- T = ChangeStreamDocument<TSchema>
Parameters
- callback: Callback<null | T>
Returns void

off

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

Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.off
- Defined in src/mongo_types.ts:375
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStreamCursor<TSchema>

on

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

Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.on
- Defined in src/mongo_types.ts:354
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStreamCursor<TSchema>

once

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

Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.once
- Defined in src/mongo_types.ts:361
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStreamCursor<TSchema>

prependListener

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

Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.prependListener
- Defined in src/mongo_types.ts:403
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStreamCursor<TSchema>

prependOnceListener

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

Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.prependOnceListener
- Defined in src/mongo_types.ts:413
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStreamCursor<TSchema>

rawListeners

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

Inherited from AbstractCursor.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][]

readBufferedDocuments

readBufferedDocuments(number?: number): ChangeStreamDocument<TSchema>[]

Inherited from AbstractCursor.readBufferedDocuments
- Defined in src/cursor/abstract_cursor.ts:220
Returns current buffered documents

Parameters
- Optional number: number
Returns ChangeStreamDocument<TSchema>[]

removeAllListeners

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

Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>

removeListener

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

Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.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 ChangeStreamCursor<TSchema>
Inherited from AbstractCursor.removeListener
- Defined in src/mongo_types.ts:368
Parameters
- event: string | symbol
- listener: GenericListener
Returns ChangeStreamCursor<TSchema>

rewind

rewind(): void

Inherited from AbstractCursor.rewind
- Defined in src/cursor/abstract_cursor.ts:580
Rewind this cursor to its uninitialized state. Any options that are present on the cursor will remain in effect. Iterating this cursor will cause new queries to be sent to the server, even if the resultant data has already been retrieved by this cursor.

Returns void

setMaxListeners

setMaxListeners(n: number): ChangeStreamCursor<TSchema>

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

stream

stream(options?: CursorStreamOptions): Readable

Inherited from AbstractCursor.stream
- Defined in src/cursor/abstract_cursor.ts:230
Parameters
- Optional options: CursorStreamOptions
Returns Readable

toArray

toArray<T>(): Promise<T[]>
toArray<T>(callback: Callback<T[]>): void

Inherited from AbstractCursor.toArray
- Defined in src/cursor/abstract_cursor.ts:424
Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contains partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.

Type parameters
- T = ChangeStreamDocument<TSchema>
Returns Promise<T[]>
Inherited from AbstractCursor.toArray
- Defined in src/cursor/abstract_cursor.ts:425
Type parameters
- T = ChangeStreamDocument<TSchema>
Parameters
- callback: Callback<T[]>
Returns void

tryNext

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

Inherited from AbstractCursor.tryNext
- Defined in src/cursor/abstract_cursor.ts:297
Try to get the next available document from the cursor or null if an empty batch is returned

Type parameters
- T = ChangeStreamDocument<TSchema>
Returns Promise<null | T>
Inherited from AbstractCursor.tryNext
- Defined in src/cursor/abstract_cursor.ts:298
Type parameters
- T = ChangeStreamDocument<TSchema>
Parameters
- callback: Callback<null | T>
Returns void

withReadConcern

withReadConcern(readConcern: ReadConcernLike): ChangeStreamCursor<TSchema>

Inherited from AbstractCursor.withReadConcern
- Defined in src/cursor/abstract_cursor.ts:531
Set the ReadPreference for the cursor.

Parameters
- readConcern: ReadConcernLike
Returns ChangeStreamCursor<TSchema>

withReadPreference

withReadPreference(readPreference: ReadPreferenceLike): ChangeStreamCursor<TSchema>

Inherited from AbstractCursor.withReadPreference
- Defined in src/cursor/abstract_cursor.ts:513
Set the ReadPreference for the cursor.

Parameters
- readPreference: ReadPreferenceLike
  
  The new read preference for the cursor.
Returns ChangeStreamCursor<TSchema>

Static getEventListener

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

Inherited from AbstractCursor.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 AbstractCursor.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 AbstractCursor.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 AbstractCursor.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 AbstractCursor.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

topology: Topology

namespace: MongoDBNamespace

pipeline: Document[] = []

options: ChangeStreamCursorOptions = {}

Returns ChangeStreamCursor<TSchema>

Events

Static Readonly CLOSE

Properties

[kClosed]

[kDocuments]

Optional [kId]

[kInitialized]

[kKilled]

[kNamespace]

[kOptions]

Optional [kServer]

Optional [kSession]

[kTopology]

Optional [kTransform]

Type declaration

Parameters

doc: ChangeStreamDocument<TSchema>

Returns Document

_resumeToken

Optional hasReceived

options

pipeline

Optional postBatchResumeToken

resumeAfter

startAfter

Optional startAtOperationTime

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors

closed

Returns boolean

cursorOptions

Returns InternalAbstractCursorOptions

id

Returns undefined | Long

killed

Returns boolean

namespace

Returns MongoDBNamespace

readConcern

Returns undefined | ReadConcern

readPreference

Returns ReadPreference

resumeOptions

Returns ResumeOptions

resumeToken

Returns unknown

Parameters

token: unknown

Returns void

server

Returns undefined | Server

session

Returns undefined | ClientSession

Parameters

clientSession: undefined | ClientSession

Returns void

topology

Returns Topology