The AggregationCursor class is an internal class that embodies an aggregation cursor on MongoDB allowing for iteration over the results returned from the underlying query. It supports one by one document iteration, conversion to an array or can be iterated as a Node 4.X or higher stream
Sets or gets the default captureRejection value for all emitters.
This symbol shall be used to install a listener for only monitoring
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
'error' listener is installed.
Add a cursor flag to the cursor
The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
The flag boolean value.
Returns current buffered documents length
Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
Iterates over all the documents for this cursor using the iterator, callback pattern.
The iteration callback.
Add a limit stage to the aggregation pipeline
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.
Set a maxTimeMS on the cursor query, allowing for hard timeout limits on queries (Only supported on MongoDB 2.6 or higher)
Number of milliseconds to wait before aborting the query.
Add a out stage to the aggregation pipeline
Returns current buffered documents
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.
Add a skip stage to the aggregation pipeline
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.
Try to get the next available document from the cursor or
null if an empty batch is returned
Returns a list listener for a specific emitter event name.
Generated using TypeDoc