The interface representing the collection's documents
The interface or class used to represent the wrapped documents.
Creates a new Iridium cursor which wraps a MongoDB cursor object
The Iridium model that this cursor belongs to
The conditions that resulte in this cursor being created
The MongoDB native cursor object to be wrapped
The conditions that resulte in this cursor being created
The MongoDB native cursor object to be wrapped
The Iridium model that this cursor belongs to
Counts the number of documents which are matched by this cursor
A promise which will resolve with the number of documents matched by this cursor
Runs the specified handler over each instance in the query results
The handler which is triggered for each element in the query
A promise which is resolved when all operations have been dispatched
Returns a new cursor which limits the number of returned results
The maximum number of results to return
The new cursor which will return a maximum number of results
Runs the specified transform over each instance in the query results and returns the resulting transformed objects
A handler which is used to transform the result objects
A promise which is fulfilled with the results of the transformations
Retrieves the next item in the results list
A promise which is resolved with the next item
Retrieves the next item in the result list and then closes the cursor
A promise which is resolved once the item becomes available and the cursor has been closed.
Returns a new cursor which will read from the specified node type.
The type of node to read from - see https://docs.mongodb.org/manual/core/read-preference/
The new cursor which reads from the specified node type
Returns a new cursor which behaves the same as this one did before any results were retrieved
The new cursor which starts at the beginning of the results
Returns a new cursor which skips a number of results before it begins returning any.
The number of results to skip before the cursor beings returning
The new cursor which skips a number of results
Returns a new cursor which sorts its results by the given index expression
The index expression dictating the sort order and direction to use
The new cursor which sorts its results by the sortExpression
Retrieves all matching instances and returns them in an array
A promise which resolves with the instances returned by the query
Generated using TypeDoc
An Iridium collection cursor which allows the itteration through documents in the collection, automatically wrapping them in the correct instance type.