Skip to content

Commit

Permalink
docs(Collection): updated Collection.aggregate()
Browse files Browse the repository at this point in the history
Changed pipeline parameter to optional
  • Loading branch information
mjomble authored and daprahamian committed Jun 28, 2018
1 parent cddaba0 commit 31b7e86
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion lib/collection.js
Original file line number Diff line number Diff line change
Expand Up @@ -1682,7 +1682,7 @@ Collection.prototype.findAndRemove = function(query, sort, options, callback) {
/**
* Execute an aggregation framework pipeline against the collection, needs MongoDB >= 2.2
* @method
* @param {object} pipeline Array containing all the aggregation framework commands for the execution.
* @param {object} [pipeline=[]] Array containing all the aggregation framework commands for the execution.
* @param {object} [options] Optional settings.
* @param {(ReadPreference|string)} [options.readPreference] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
* @param {object} [options.cursor] Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.
Expand Down

0 comments on commit 31b7e86

Please sign in to comment.