Skip to content

Commit

Permalink
docs(model): document timestamps option for Document#save() re: #…
Browse files Browse the repository at this point in the history
  • Loading branch information
vkarpov15 committed Jan 12, 2019
1 parent 17819f1 commit 804e057
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions lib/model.js
Expand Up @@ -427,6 +427,7 @@ function generateVersionError(doc, modifiedPaths) {
* @param {Boolean} [options.j] set to true for MongoDB to wait until this `save()` has been [journaled before resolving the returned promise](https://docs.mongodb.com/manual/reference/write-concern/#j-option). Overrides the [schema-level `writeConcern` option](/docs/guide.html#writeConcern)
* @param {Number} [options.wtimeout] sets a [timeout for the write concern](https://docs.mongodb.com/manual/reference/write-concern/#wtimeout). Overrides the [schema-level `writeConcern` option](/docs/guide.html#writeConcern).
* @param {Boolean} [options.checkKeys=true] the MongoDB driver prevents you from saving keys that start with '$' or contain '.' by default. Set this option to `false` to skip that check. See [restrictions on field names](https://docs.mongodb.com/manual/reference/limits/#Restrictions-on-Field-Names)
* @param {Boolean} [options.timestamps=true] if `false` and [timestamps](./guide.html#timestamps) are enabled, skip timestamps for this `save()`.
* @param {Function} [fn] optional callback
* @return {Promise|undefined} Returns undefined if used with callback or a Promise otherwise.
* @api public
Expand Down

0 comments on commit 804e057

Please sign in to comment.