fix(query): set deletedCount on result of remove()

Fix #7629
Automattic · Apr 7, 2019 · 76d8ca5 · 76d8ca5
1 parent d101c68
commit 76d8ca5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/lib/model.js b/lib/model.js
@@ -1674,13 +1674,14 @@ Model.translateAliases = function translateAliases(fields) {
  *
  * ####Example:
  *
- *     Character.remove({ name: 'Eddard Stark' }, function (err) {});
+ *     const res = await Character.remove({ name: 'Eddard Stark' });
+ *     res.deletedCount; // Number of documents removed
  *
  * ####Note:
  *
  * This method sends a remove command directly to MongoDB, no Mongoose documents
- * are involved. Because no Mongoose documents are involved, _no middleware
- * (hooks) are executed_.
+ * are involved. Because no Mongoose documents are involved, Mongoose does
+ * not execute [document middleware](/docs/middleware.html#types-of-middleware).
  *
  * @param {Object} conditions
  * @param {Function} [callback]

diff --git a/lib/queryhelpers.js b/lib/queryhelpers.js
@@ -316,7 +316,13 @@ exports.handleDeleteWriteOpResult = function handleDeleteWriteOpResult(callback)
     if (error) {
       return callback(error);
     }
-    return callback(null,
-      Object.assign({}, res.result, {deletedCount: res.deletedCount }));
+    const mongooseResult = Object.assign({}, res.result);
+    if (get(res, 'result.n', null) != null) {
+      mongooseResult.deletedCount = res.result.n;
+    }
+    if (res.deletedCount != null) {
+      mongooseResult.deletedCount = res.deletedCount;
+    }
+    return callback(null, mongooseResult);
   };
 };