add undefined return to {model,doc}.save

Automattic · Jun 18, 2018 · 9821432 · 9821432
1 parent 3fed6f0
commit 9821432
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/lib/document.js b/lib/document.js
@@ -1931,7 +1931,7 @@ Document.prototype.$markValid = function(path) {
  * @method save
  * @memberOf Document
  * @instance
- * @return {Promise} Promise
+ * @return {Promise|undefined} Returns undefined if used with callback or a Promise otherwise.
  * @api public
  * @see middleware http://mongoosejs.com/docs/middleware.html
  */

diff --git a/lib/model.js b/lib/model.js
@@ -327,7 +327,7 @@ Model.prototype.$__save = function(options, callback) {
  * @param {Object} [options.safe] overrides [schema's safe option](http://mongoosejs.com//docs/guide.html#safe)
  * @param {Boolean} [options.validateBeforeSave] set to false to save without validating.
  * @param {Function} [fn] optional callback
- * @return {Promise} Promise
+ * @return {Promise|undefined} Returns undefined with callback or a Promise otherwise.
  * @api public
  * @see middleware http://mongoosejs.com/docs/middleware.html
  */