+ 
404: Page not found
- - - - - - - + + + + + + +Class AbstractCursor<TSchema, CursorEvents>Abstract
Type Parameters
- TSchema = any
- CursorEvents extends AbstractCursorEvents = AbstractCursorEvents
Hierarchy (view full)
Implements
Index
Properties
Class AbstractCursor<TSchema, CursorEvents>Abstract
Type Parameters
- TSchema = any
- CursorEvents extends AbstractCursorEvents = AbstractCursorEvents
Hierarchy (view full)
Implements
Index
Properties
Properties
[async
Staticcapture
Value: boolean
+Protectedsignal
Staticcapture
Value: boolean
Change the default captureRejections option on all new EventEmitter objects.
Static Readonlycapture
Value: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
Static ReadonlyCLOSE
Staticdefault
By default, a maximum of 10 listeners can be registered for any single
+
Static ReadonlyCLOSE
Staticdefault
By default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListeners property
@@ -90,57 +91,57 @@
regular 'error' listener is installed.
Accessors
closed
- get closed(): boolean
The cursor is closed and all remaining locally buffered documents have been iterated.
-Returns boolean
id
- get id(): undefined | Long
The cursor has no id until it receives a response from the initial cursor creating command.
+Returns boolean
id
killed
- get killed(): boolean
A
killCursorscommand was attempted on this cursor. +Returns undefined | Long
killed
- get killed(): boolean
A
-killCursorscommand was attempted on this cursor. This is performed if the cursor id is non zero.Returns boolean
load
- get loadBalanced(): boolean
Returns boolean
namespace
- get namespace(): MongoDBNamespace
Returns MongoDBNamespace
read
- get readConcern(): undefined | ReadConcern
Returns undefined | ReadConcern
read
- get readPreference(): ReadPreference
Returns ReadPreference
session
- set session(clientSession): void
Parameters
- clientSession: ClientSession
Returns void
Methods
[async
Optional[capture
- [capture
Rejection Symbol]<K>(error, event, ...args): void Type Parameters
Parameters
- error: Error
- event: string | symbol
Rest...args: AnyRest
Returns void
add
load
- get loadBalanced(): boolean
Returns boolean
namespace
- get namespace(): MongoDBNamespace
Returns MongoDBNamespace
read
- get readConcern(): undefined | ReadConcern
Returns undefined | ReadConcern
read
- get readPreference(): ReadPreference
Returns ReadPreference
session
- set session(clientSession): void
Parameters
- clientSession: ClientSession
Returns void
Methods
[async
Optional[capture
- [capture
Rejection Symbol]<K>(error, event, ...args): void Type Parameters
Parameters
- error: Error
- event: string | symbol
Rest...args: AnyRest
Returns void
add
- add
Cursor Flag(flag, value): this Add a cursor flag to the cursor
Parameters
- flag:
| "tailable"
| "oplogReplay"
| "noCursorTimeout"
| "awaitData"
| "exhaust"
| "partial"The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
- value: boolean
The flag boolean value.
-
Returns this
- flag:
add
- add
Listener<EventKey>(event, listener): this Alias for
+emitter.on(eventName, listener).
Returns this
add
- add
Listener<EventKey>(event, listener): this Alias for
emitter.on(eventName, listener).Type Parameters
Parameters
- event: EventKey
- listener: CursorEvents[EventKey]
Returns this
- add
Listener(event, listener): this Alias for
+emitter.on(eventName, listener).- add
Listener(event, listener): this Alias for
emitter.on(eventName, listener).Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
- (eventName, listener): void
Parameters
- eventName: string | symbol
- listener: GenericListener
Returns void
Returns this
- add
Listener(event, listener): this Alias for
+emitter.on(eventName, listener).- add
Listener(event, listener): this Alias for
emitter.on(eventName, listener).Parameters
- event: string | symbol
- listener: GenericListener
Returns this
batch
batch
- batch
Size(value): this Set the batch size for the cursor.
Parameters
- value: number
The number of documents to return per batch. See command documentation.
-
Returns this
- value: number
buffered
Abstractclone
- clone(): AbstractCursor<TSchema, AbstractCursorEvents>
Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
-Returns AbstractCursor<TSchema, AbstractCursorEvents>
close
emit
- emit<EventKey>(event, ...args): boolean
Synchronously calls each of the listeners registered for the event named
eventName, in the order they were registered, passing the supplied arguments +
Returns this
buffered
Abstractclone
- clone(): AbstractCursor<TSchema, AbstractCursorEvents>
Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
+Returns AbstractCursor<TSchema, AbstractCursorEvents>
close
emit
- emit<EventKey>(event, ...args): boolean
Synchronously calls each of the listeners registered for the event named
eventName, in the order they were registered, passing the supplied arguments to each.Returns
trueif the event had listeners,falseotherwise.import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listenerType Parameters
Parameters
- event: symbol | EventKey
Rest...args: Parameters<CursorEvents[EventKey]>
Returns boolean
event
event
- event
Names(): string[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or
Symbols.import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]Returns string[]
for
for
get
- get
Max Listeners(): number Returns the current max listener value for the
+EventEmitterwhich is either -set byemitter.setMaxListeners(n)or defaults to defaultMaxListeners.
get
- get
Max Listeners(): number Returns the current max listener value for the
EventEmitterwhich is either +set byemitter.setMaxListeners(n)or defaults to EventEmitter.defaultMaxListeners.Returns number
has
listener
- listener
Count<EventKey>(type): number Returns the number of listeners listening for the event named
eventName. +
has
listener
- listener
Count<EventKey>(type): number Returns the number of listeners listening for the event named
eventName. Iflisteneris provided, it will return how many times the listener is found in the list of the listeners of the event.Type Parameters
Parameters
- type: string | symbol | EventKey
Returns number
listeners
- listeners<EventKey>(event): CursorEvents[EventKey][]
Returns a copy of the array of listeners for the event named
+eventName.
listeners
- listeners<EventKey>(event): CursorEvents[EventKey][]
Returns a copy of the array of listeners for the event named
eventName.server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]Type Parameters
Parameters
- event: string | symbol | EventKey
Returns CursorEvents[EventKey][]
map
- map<T>(transform): AbstractCursor<T, AbstractCursorEvents>
Map all documents using the provided function +
map
- map<T>(transform): AbstractCursor<T, AbstractCursorEvents>
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.
Type Parameters
Parameters
- transform: ((doc: TSchema) => T)
The mapping transformation method.
@@ -161,16 +162,16 @@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[]
max
TimeMS max
TimeMS next
off
- off<EventKey>(event, listener): this
Alias for
+emitter.removeListener().
Returns this
- transform: ((doc: TSchema) => T)
next
off
- off<EventKey>(event, listener): this
Alias for
emitter.removeListener().Type Parameters
Parameters
- event: EventKey
- listener: CursorEvents[EventKey]
Returns this
- off(event, listener): this
Alias for
+emitter.removeListener().- off(event, listener): this
Alias for
emitter.removeListener().Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
- (eventName, listener): void
Parameters
- eventName: string | symbol
- listener: GenericListener
Returns void
Returns this
- off(event, listener): this
Alias for
+emitter.removeListener().- off(event, listener): this
Alias for
emitter.removeListener().Parameters
- event: string | symbol
- listener: GenericListener
Returns this
on
- on<EventKey>(event, listener): this
Adds the
listenerfunction to the end of the listeners array for the event +
on
- on<EventKey>(event, listener): this
Adds the
@@ -185,7 +186,7 @@listenerfunction to the end of the listeners array for the event namedeventName. No checks are made to see if thelistenerhas already been added. Multiple calls passing the same combination ofeventNameandlistenerwill result in thelistenerbeing added, and called, multiple times.Example
Type Parameters
Parameters
- event: EventKey
- listener: CursorEvents[EventKey]
The callback function
Returns this
- on(event, listener): this
Adds the
listenerfunction to the end of the listeners array for the event +- on(event, listener): this
Adds the
@@ -200,7 +201,7 @@listenerfunction to the end of the listeners array for the event namedeventName. No checks are made to see if thelistenerhas already been added. Multiple calls passing the same combination ofeventNameandlistenerwill result in thelistenerbeing added, and called, multiple times.Example
Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
The callback function
- (eventName, listener): void
Parameters
- eventName: string | symbol
- listener: GenericListener
Returns void
Returns this
- on(event, listener): this
Adds the
listenerfunction to the end of the listeners array for the event +- on(event, listener): this
+Adds the
@@ -215,7 +216,7 @@listenerfunction to the end of the listeners array for the event namedeventName. No checks are made to see if thelistenerhas already been added. Multiple calls passing the same combination ofeventNameandlistenerwill result in thelistenerbeing added, and called, multiple times.Example
Parameters
- event: string | symbol
- listener: GenericListener
The callback function
Returns this
once
- once<EventKey>(event, listener): this
Adds a one-time
listenerfunction for the event namedeventName. The +
once
- once<EventKey>(event, listener): this
Adds a one-time
listenerfunction for the event namedeventName. The next timeeventNameis triggered, this listener is removed and then invoked.
@@ -228,7 +229,7 @@server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});Example
Type Parameters
Parameters
- event: EventKey
- listener: CursorEvents[EventKey]
The callback function
Returns this
- once(event, listener): this
Adds a one-time
listenerfunction for the event namedeventName. The +- once(event, listener): this
Adds a one-time
listenerfunction for the event namedeventName. The next timeeventNameis triggered, this listener is removed and then invoked.
@@ -241,7 +242,7 @@server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});Example
Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
The callback function
- (eventName, listener): void
Parameters
- eventName: string | symbol
- listener: GenericListener
Returns void
Returns this
- once(event, listener): this
Adds a one-time
listenerfunction for the event namedeventName. The +- once(event, listener): this
Adds a one-time
listenerfunction for the event namedeventName. The next timeeventNameis triggered, this listener is removed and then invoked.
@@ -254,7 +255,7 @@server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});Example
Parameters
- event: string | symbol
- listener: GenericListener
The callback function
Returns this
prepend
Listener - prepend
Listener<EventKey>(event, listener): this Adds the
listenerfunction to the beginning of the listeners array for the +
prepend
Listener - prepend
Listener<EventKey>(event, listener): this Adds the
@@ -264,7 +265,7 @@listenerfunction to the beginning of the listeners array for the event namedeventName. No checks are made to see if thelistenerhas already been added. Multiple calls passing the same combination ofeventNameandlistenerwill result in thelistenerbeing added, and called, multiple times.ExampleReturns a reference to the
EventEmitter, so that calls can be chained.Type Parameters
Parameters
- event: EventKey
- listener: CursorEvents[EventKey]
The callback function
Returns this
- prepend
Listener(event, listener): this Adds the
listenerfunction to the beginning of the listeners array for the +- prepend
Listener(event, listener): this Adds the
@@ -274,7 +275,7 @@listenerfunction to the beginning of the listeners array for the event namedeventName. No checks are made to see if thelistenerhas already been added. Multiple calls passing the same combination ofeventNameandlistenerwill result in thelistenerbeing added, and called, multiple times.ExampleReturns a reference to the
EventEmitter, so that calls can be chained.Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
The callback function
- (eventName, listener): void
Parameters
- eventName: string | symbol
- listener: GenericListener
Returns void
Returns this
- prepend
Listener(event, listener): this Adds the
listenerfunction to the beginning of the listeners array for the +- prepend
Listener(event, listener): this Adds the
@@ -284,7 +285,7 @@listenerfunction to the beginning of the listeners array for the event namedeventName. No checks are made to see if thelistenerhas already been added. Multiple calls passing the same combination ofeventNameandlistenerwill result in thelistenerbeing added, and called, multiple times.ExampleReturns a reference to the
EventEmitter, so that calls can be chained.Parameters
- event: string | symbol
- listener: GenericListener
The callback function
Returns this
prepend
Once Listener - prepend
Once Listener<EventKey>(event, listener): this Adds a one-time
listenerfunction for the event namedeventNameto the beginning of the listeners array. The next timeeventNameis triggered, this +
prepend
Once Listener - prepend
Once Listener<EventKey>(event, listener): this Adds a one-time
listenerfunction for the event namedeventNameto the beginning of the listeners array. The next timeeventNameis triggered, this listener is removed, and then invoked.
@@ -292,7 +293,7 @@server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});ExampleReturns a reference to the
EventEmitter, so that calls can be chained.Type Parameters
Parameters
- event: EventKey
- listener: CursorEvents[EventKey]
The callback function
Returns this
- prepend
Once Listener(event, listener): this Adds a one-time
listenerfunction for the event namedeventNameto the beginning of the listeners array. The next timeeventNameis triggered, this +- prepend
Once Listener(event, listener): this Adds a one-time
listenerfunction for the event namedeventNameto the beginning of the listeners array. The next timeeventNameis triggered, this listener is removed, and then invoked.
@@ -300,7 +301,7 @@server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});ExampleReturns a reference to the
EventEmitter, so that calls can be chained.Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
The callback function
- (eventName, listener): void
Parameters
- eventName: string | symbol
- listener: GenericListener
Returns void
Returns this
- prepend
Once Listener(event, listener): this Adds a one-time
listenerfunction for the event namedeventNameto the beginning of the listeners array. The next timeeventNameis triggered, this +- prepend
Once Listener(event, listener): this Adds a one-time
listenerfunction for the event namedeventNameto the beginning of the listeners array. The next timeeventNameis triggered, this listener is removed, and then invoked.
@@ -308,20 +309,20 @@server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});ExampleReturns a reference to the
EventEmitter, so that calls can be chained.Parameters
- event: string | symbol
- listener: GenericListener
The callback function
Returns this
raw
Listeners - raw
Listeners<EventKey>(event): CursorEvents[EventKey][] Returns a copy of the array of listeners for the event named
eventName, +
raw
Listeners - raw
Listeners<EventKey>(event): CursorEvents[EventKey][] Returns a copy of the array of listeners for the event named
eventName, including any wrappers (such as those created by.once()).import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');Type Parameters
Parameters
- event: string | symbol | EventKey
Returns CursorEvents[EventKey][]
read
Buffered Documents remove
All Listeners - remove
All Listeners<EventKey>(event?): this Removes all listeners, or those of the specified
+eventName.
read
Buffered Documents remove
All Listeners - remove
All Listeners<EventKey>(event?): this Removes all listeners, or those of the specified
eventName.It is bad practice to remove listeners added elsewhere in the code, particularly when the
EventEmitterinstance was created by some other component or module (e.g. sockets or file streams).Returns a reference to the
EventEmitter, so that calls can be chained.Type Parameters
Parameters
Optionalevent: string | symbol | EventKey
Returns this
remove
Listener - remove
Listener<EventKey>(event, listener): this Removes the specified
+listenerfrom the listener array for the event namedeventName.
remove
Listener - remove
Listener<EventKey>(event, listener): this Removes the specified
listenerfrom the listener array for the event namedeventName.
@@ -348,7 +349,7 @@const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);ExampleReturns a reference to the
EventEmitter, so that calls can be chained.Type Parameters
Parameters
- event: EventKey
- listener: CursorEvents[EventKey]
Returns this
- remove
Listener(event, listener): this Removes the specified
+listenerfrom the listener array for the event namedeventName.- remove
Listener(event, listener): this Removes the specified
listenerfrom the listener array for the event namedeventName.
@@ -375,7 +376,7 @@const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);ExampleReturns a reference to the
EventEmitter, so that calls can be chained.Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
- (eventName, listener): void
Parameters
- eventName: string | symbol
- listener: GenericListener
Returns void
Returns this
- remove
Listener(event, listener): this Removes the specified
+listenerfrom the listener array for the event namedeventName.- remove
Listener(event, listener): this Removes the specified
listenerfrom the listener array for the event namedeventName.
@@ -402,24 +403,24 @@const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);ExampleReturns a reference to the
EventEmitter, so that calls can be chained.Parameters
- event: string | symbol
- listener: GenericListener
Returns this
rewind
rewind
set
Max Listeners set
Max Listeners - set
Max Listeners(n): this By default
EventEmitters will print a warning if more than10listeners are added for a particular event. This is a useful default that helps finding memory leaks. Theemitter.setMaxListeners()method allows the limit to be modified for this specificEventEmitterinstance. The value can be set toInfinity(or0) to indicate an unlimited number of listeners.Returns a reference to the
EventEmitter, so that calls can be chained.Parameters
- n: number
Returns this
stream
- stream(options?): Readable & AsyncIterable<TSchema>
Parameters
Optionaloptions: CursorStreamOptions
Returns Readable & AsyncIterable<TSchema>
to
Array - to
Array(): Promise<TSchema[]> Returns an array of documents. The caller is responsible for making sure that there +
stream
- stream(options?): Readable & AsyncIterable<TSchema>
Parameters
Optionaloptions: CursorStreamOptions
Returns Readable & AsyncIterable<TSchema>
to
Array - to
Array(): Promise<TSchema[]> 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.
-Returns Promise<TSchema[]>
try
Next with
Read Concern - with
Read Concern(readConcern): this Set the ReadPreference for the cursor.
-Parameters
- readConcern: ReadConcernLike
Returns this
with
Read Preference - with
Read Preference(readPreference): this Set the ReadPreference for the cursor.
+Returns Promise<TSchema[]>
try
Next with
Read Concern - with
Read Concern(readConcern): this Set the ReadPreference for the cursor.
+Parameters
- readConcern: ReadConcernLike
Returns this
with
Read Preference - with
Read Preference(readPreference): this Set the ReadPreference for the cursor.
Parameters
- readPreference: ReadPreferenceLike
The new read preference for the cursor.
-
Returns this
- readPreference: ReadPreferenceLike
StaticaddAbort Listener Returns this
StaticaddAbort Listener Returns void
An alias for AbstractCursor.close|AbstractCursor.close().
-