+ 
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
+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,15 +90,15 @@
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).Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
- (eventName, listener): void
Parameters
- eventName: string | symbol
- listener: GenericListener
Returns void
Returns this
Parameters
- event: string | symbol
- listener: GenericListener
Returns this
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 listener @@ -128,10 +128,10 @@- (doc): boolean | void
Parameters
- doc: TSchema
Returns boolean | void
Returns Promise<void>
get
get
- get
Max Listeners(): number Returns the current max listener value for the
EventEmitterwhich is either set byemitter.setMaxListeners(n)or defaults to 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
max
max
next
off
- off<EventKey>(event, listener): this
Alias for
+emitter.removeListener().
Returns this
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().Parameters
- event: CommonEvents
- listener: ((eventName: string | symbol, listener: GenericListener) => void)
- (eventName, listener): void
Parameters
- eventName: string | symbol
- listener: GenericListener
Returns void
Returns this
Since
v10.0.0
@@ -315,7 +315,7 @@Example
Type Parameters
Parameters
- event: string | symbol | EventKey
Returns CursorEvents[EventKey][]
read
Buffered Documents remove
All Listeners 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
@@ -405,21 +405,21 @@EventEmitterinstance was created by some other component or module (e.g. sockets or file streams).Example
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
- set
StaticaddAbort Listener - add
Abort Listener(signal, resource): Disposable ExperimentalListens once to the
abortevent on the providedsignal.Listening to the
abortevent on abort signals is unsafe and may lead to resource leaks since another third party with the signal can calle.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -461,7 +461,7 @@Example
- eventName: string | symbol
The event name
Returns number
- eventName: string | symbol
Staticon- on(emitter, eventName, options?): AsyncIterableIterator<any[]>
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here +
Staticon- on(emitter, eventName, options?): AsyncIterator<any[], any, any>
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable hereReturns an
AsyncIteratorthat iterateseventNameevents. It will throw @@ -476,9 +476,9 @@Deprecat
-import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
ee.emit('close');
});
for await (const event of on(ee, 'foo', { close: ['close'] })) {
console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'Parameters
- emitter: EventEmitter<DefaultEventMap>
- eventName: string | symbol
Optionaloptions: StaticEventEmitterIteratorOptions
Returns AsyncIterableIterator<any[]>
An
+AsyncIteratorthat iterateseventNameevents emitted by theemitter
Parameters
- emitter: EventEmitter<DefaultEventMap>
- eventName: string | symbol
Optionaloptions: StaticEventEmitterIteratorOptions
Returns AsyncIterator<any[], any, any>
An
AsyncIteratorthat iterateseventNameevents emitted by theemitter- on(emitter, eventName, options?): AsyncIterableIterator<any[]>
Parameters
- emitter: EventTarget
- eventName: string
Optionaloptions: StaticEventEmitterIteratorOptions
Returns AsyncIterableIterator<any[]>
Staticonce
- once(emitter, eventName, options?): Promise<any[]>
Creates a
Promisethat is fulfilled when theEventEmitteremits the given +- 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[]>
Creates a
@@ -502,5 +502,7 @@Promisethat is fulfilled when theEventEmitteremits the given event or that is rejected if theEventEmitteremits'error'while waiting. ThePromisewill resolve with an array of all the arguments emitted to the given event.Deprecat
Parameters
Optionaln: numberA non-negative number. The maximum number of listeners per
-EventTargetevent.Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]
Returns void
Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]Zero or more {EventTarget} or {EventEmitter} instances. If none are specified,
+nis set as the default max for all newly created {EventTarget} and {EventEmitter} +objects.
An alias for AbstractCursor.close|AbstractCursor.close().
-