Skip to content

Commit

Permalink
docs(virtualtype): document count option
Browse files Browse the repository at this point in the history
  • Loading branch information
vkarpov15 committed Jan 14, 2019
1 parent 60a68df commit 9a546b1
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions lib/virtualtype.js
Expand Up @@ -16,6 +16,7 @@
* @param {string|function} [options.foreignField] the foreign field to populate on if this is a populated virtual.
* @param {boolean} [options.justOne=false] by default, a populated virtual is an array. If you set `justOne`, the populated virtual will be a single doc or `null`.
* @param {boolean} [options.getters=false] if you set this to `true`, Mongoose will call any custom getters you defined on this virtual
* @param {boolean} [options.count=false] if you set this to `true`, `populate()` will set this virtual to the number of populated documents, as opposed to the documents themselves, using [`Query#countDocuments()`](./api.html#query_Query-countDocuments)
* @api public
*/

Expand Down

0 comments on commit 9a546b1

Please sign in to comment.