Skip to content

Commit fe0d1c5

Browse files
vkarpov15vkarpov15
committed
docs(query): add more detailed docs re: options
Fix #1702
1 parent dc19eac commit fe0d1c5

File tree

2 files changed

+34
-27
lines changed

2 files changed

+34
-27
lines changed

‎lib/model.js‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1326,7 +1326,7 @@ Model.deleteMany = function deleteMany(conditions, callback) {
13261326
*
13271327
* @param {Object} conditions
13281328
* @param {Object} [projection] optional fields to return (http://bit.ly/1HotzBo)
1329-
* @param {Object} [options] optional
1329+
* @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
13301330
* @param {Function} [callback]
13311331
* @return {Query}
13321332
* @see field selection #query_Query-select
@@ -1406,7 +1406,7 @@ Model.find = function find(conditions, projection, options, callback) {
14061406
*
14071407
* @param {Object|String|Number} id value of `_id` to query by
14081408
* @param {Object} [projection] optional fields to return (http://bit.ly/1HotzBo)
1409-
* @param {Object} [options] optional
1409+
* @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
14101410
* @param {Function} [callback]
14111411
* @return {Query}
14121412
* @see field selection #query_Query-select
@@ -1460,7 +1460,7 @@ Model.findById = function findById(id, projection, options, callback) {
14601460
*
14611461
* @param {Object} [conditions]
14621462
* @param {Object} [projection] optional fields to return (http://bit.ly/1HotzBo)
1463-
* @param {Object} [options] optional
1463+
* @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
14641464
* @param {Function} [callback]
14651465
* @return {Query}
14661466
* @see field selection #query_Query-select
@@ -1685,7 +1685,7 @@ Model.$where = function $where() {
16851685
*
16861686
* @param {Object} [conditions]
16871687
* @param {Object} [update]
1688-
* @param {Object} [options]
1688+
* @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
16891689
* @param {Function} [callback]
16901690
* @return {Query}
16911691
* @see mongodb http://www.mongodb.org/display/DOCS/findAndModify+Command
@@ -1804,7 +1804,7 @@ Model.findOneAndUpdate = function(conditions, update, options, callback) {
18041804
*
18051805
* @param {Object|Number|String} id value of `_id` to query by
18061806
* @param {Object} [update]
1807-
* @param {Object} [options]
1807+
* @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
18081808
* @param {Function} [callback]
18091809
* @return {Query}
18101810
* @see Model.findOneAndUpdate #model_Model.findOneAndUpdate
@@ -1881,7 +1881,7 @@ Model.findByIdAndUpdate = function(id, update, options, callback) {
18811881
* });
18821882
*
18831883
* @param {Object} conditions
1884-
* @param {Object} [options]
1884+
* @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
18851885
* @param {Function} [callback]
18861886
* @return {Query}
18871887
* @see mongodb http://www.mongodb.org/display/DOCS/findAndModify+Command
@@ -1943,7 +1943,7 @@ Model.findOneAndRemove = function(conditions, options, callback) {
19431943
* A.findByIdAndRemove() // returns Query
19441944
*
19451945
* @param {Object|Number|String} id value of `_id` to query by
1946-
* @param {Object} [options]
1946+
* @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
19471947
* @param {Function} [callback]
19481948
* @return {Query}
19491949
* @see Model.findOneAndRemove #model_Model.findOneAndRemove
@@ -2507,7 +2507,7 @@ Model.hydrate = function(obj) {
25072507
* @see response http://docs.mongodb.org/v2.6/reference/command/update/#output
25082508
* @param {Object} conditions
25092509
* @param {Object} doc
2510-
* @param {Object} [options]
2510+
* @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
25112511
* @param {Function} [callback]
25122512
* @return {Query}
25132513
* @api public
@@ -2530,7 +2530,7 @@ Model.update = function update(conditions, doc, options, callback) {
25302530
*
25312531
* @param {Object} conditions
25322532
* @param {Object} doc
2533-
* @param {Object} [options]
2533+
* @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
25342534
* @param {Function} [callback]
25352535
* @return {Query}
25362536
* @api public
@@ -2549,7 +2549,7 @@ Model.updateMany = function updateMany(conditions, doc, options, callback) {
25492549
*
25502550
* @param {Object} conditions
25512551
* @param {Object} doc
2552-
* @param {Object} [options]
2552+
* @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
25532553
* @param {Function} [callback]
25542554
* @return {Query}
25552555
* @api public
@@ -2568,7 +2568,7 @@ Model.updateOne = function updateOne(conditions, doc, options, callback) {
25682568
*
25692569
* @param {Object} conditions
25702570
* @param {Object} doc
2571-
* @param {Object} [options]
2571+
* @param {Object} [options] optional see [`Query.prototype.setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
25722572
* @param {Function} [callback]
25732573
* @return {Query}
25742574
* @api public

‎lib/query.js‎

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -952,25 +952,31 @@ Query.prototype.read = function read(pref, tags) {
952952
*/
953953

954954
/**
955-
* Sets query options.
955+
* Sets query options. Some options only make sense for certain operations.
956956
*
957957
* ####Options:
958958
*
959-
* - [tailable](http://www.mongodb.org/display/DOCS/Tailable+Cursors) *
960-
* - [sort](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bsort(\)%7D%7D) *
961-
* - [limit](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Blimit%28%29%7D%7D) *
962-
* - [skip](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bskip%28%29%7D%7D) *
963-
* - [maxscan](https://docs.mongodb.org/v3.2/reference/operator/meta/maxScan/#metaOp._S_maxScan) *
964-
* - [batchSize](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7BbatchSize%28%29%7D%7D) *
965-
* - [comment](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24comment) *
966-
* - [snapshot](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bsnapshot%28%29%7D%7D) *
967-
* - [hint](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24hint) *
968-
* - [readPreference](http://docs.mongodb.org/manual/applications/replication/#read-preference) **
969-
* - [lean](./api.html#query_Query-lean) *
970-
* - [safe](http://www.mongodb.org/display/DOCS/getLastError+Command)
971-
*
972-
* _* denotes a query helper method is also available_
973-
* _** query helper method to set `readPreference` is `read()`_
959+
* The following options are only for `find()`:
960+
* - [tailable](http://www.mongodb.org/display/DOCS/Tailable+Cursors)
961+
* - [sort](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bsort(\)%7D%7D)
962+
* - [limit](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Blimit%28%29%7D%7D)
963+
* - [skip](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bskip%28%29%7D%7D)
964+
* - [maxscan](https://docs.mongodb.org/v3.2/reference/operator/meta/maxScan/#metaOp._S_maxScan)
965+
* - [batchSize](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7BbatchSize%28%29%7D%7D)
966+
* - [comment](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24comment)
967+
* - [snapshot](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bsnapshot%28%29%7D%7D)
968+
* - [readPreference](http://docs.mongodb.org/manual/applications/replication/#read-preference)
969+
* - [hint](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24hint)
970+
*
971+
* The following options are only for `update()`, `updateOne()`, `updateMany()`, `replaceOne()`, and `findOneAndUpdate()`:
972+
* - [upsert](https://docs.mongodb.com/manual/reference/method/db.collection.update/)
973+
* - [writeConcern](https://docs.mongodb.com/manual/reference/method/db.collection.update/)
974+
*
975+
* The following options are only for `find()`, `findOne()`, `findById()`, and `findOneAndUpdate()`:
976+
* - [lean](./api.html#query_Query-lean)
977+
*
978+
* The following options are for all operations:
979+
* - [collation](https://docs.mongodb.com/manual/reference/collation/)
974980
*
975981
* @param {Object} options
976982
* @api public
@@ -1522,6 +1528,7 @@ Query.prototype._findOne = function(callback) {
15221528
*
15231529
* @param {Object|Query} [criteria] mongodb selector
15241530
* @param {Object} [projection] optional fields to return
1531+
* @param {Object} [options] see [`setOptions()`](http://mongoosejs.com/docs/api.html#query_Query-setOptions)
15251532
* @param {Function} [callback] optional params are (error, document)
15261533
* @return {Query} this
15271534
* @see findOne http://docs.mongodb.org/manual/reference/method/db.collection.findOne/

0 commit comments

Comments
 (0)