Merge pull request #14110 from Automattic/vkarpov15/gh-14081

types(document): correct return type for `doc.deleteOne()` re: Mongoose 8 breaking change
Automattic · Nov 22, 2023 · 3e0a90c · 3e0a90c
2 parents d53b1c5 + c424f10
commit 3e0a90c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/test/types/document.test.ts b/test/types/document.test.ts
@@ -9,6 +9,7 @@ import {
   HydratedSingleSubdocument,
   DefaultSchemaOptions
 } from 'mongoose';
+import { DeleteResult } from 'mongodb';
 import { expectAssignable, expectError, expectType } from 'tsd';
 import { autoTypedModel } from './models.test';
 import { autoTypedModelConnection } from './connection.test';
@@ -39,7 +40,9 @@ const Test = model<ITest>('Test', schema);
 void async function main() {
   const doc = await Test.findOne().orFail();
 
-  expectType<Promise<TestDocument>>(doc.deleteOne());
+  expectType<DeleteResult>(await doc.deleteOne());
+  expectType<TestDocument | null>(await doc.deleteOne().findOne());
+  expectType<{ _id: Types.ObjectId, name?: string } | null>(await doc.deleteOne().findOne().lean());
 }();
 
 

diff --git a/types/document.d.ts b/types/document.d.ts
@@ -108,7 +108,13 @@ declare module 'mongoose' {
     db: Connection;
 
     /** Removes this document from the db. */
-    deleteOne(options?: QueryOptions): Promise<this>;
+    deleteOne(options?: QueryOptions): QueryWithHelpers<
+      mongodb.DeleteResult,
+      this,
+      TQueryHelpers,
+      DocType,
+      'deleteOne'
+    >;
 
     /**
      * Takes a populated field and returns it to its unpopulated state. If called with