Skip to content

Commit

Permalink
Merge pull request #13798 from RobertHunter-Pluto/update-toObject-doc…
Browse files Browse the repository at this point in the history
…s-with-missing-pathsToSkip-option

update docs to reflect change from commit 760fa73
  • Loading branch information
vkarpov15 authored Sep 1, 2023
2 parents d448894 + eb79053 commit d9a6bf1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion lib/document.js
Original file line number Diff line number Diff line change
Expand Up @@ -3918,7 +3918,7 @@ Document.prototype.$toObject = function(options, json) {
*
* @param {Object} [options]
* @param {Boolean} [options.getters=false] if true, apply all getters, including virtuals
* @param {Boolean} [options.virtuals=false] if true, apply virtuals, including aliases. Use `{ getters: true, virtuals: false }` to just apply getters, not virtuals
* @param {Boolean|Object} [options.virtuals=false] if true, apply virtuals, including aliases. Use `{ getters: true, virtuals: false }` to just apply getters, not virtuals. An object of the form `{ pathsToSkip: ['someVirtual'] }` may also be used to omit specific virtuals.
* @param {Boolean} [options.aliases=true] if `options.virtuals = true`, you can set `options.aliases = false` to skip applying aliases. This option is a no-op if `options.virtuals = false`.
* @param {Boolean} [options.minimize=true] if true, omit any empty objects from the output
* @param {Function|null} [options.transform=null] if set, mongoose will call this function to allow you to transform the returned object
Expand Down

0 comments on commit d9a6bf1

Please sign in to comment.