Merge pull request #13367 from Automattic/vkarpov15/deleteone-ts

types(document): correct return type for `Model.prototype.deleteOne()`: promise, not query
Automattic · May 2, 2023 · 1c4e6a9 · 1c4e6a9
2 parents a67b7a7 + 250d160
commit 1c4e6a9
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/test/types/document.test.ts b/test/types/document.test.ts
@@ -39,7 +39,7 @@ const Test = model<ITest>('Test', schema);
 void async function main() {
   const doc = await Test.findOne().orFail();
 
-  expectType<Query<any, TestDocument>>(doc.deleteOne());
+  expectType<Promise<TestDocument>>(doc.deleteOne());
 }();
 
 

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