Merge pull request #14153 from Automattic/vkarpov15/gh-14130

types: make findOneAndDelete() without options return result doc, not ModifyResult
Automattic · Dec 5, 2023 · 4d7f71d · 4d7f71d
2 parents cc46cfb + ffdb091
commit 4d7f71d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/test/types/models.test.ts b/test/types/models.test.ts
@@ -854,6 +854,15 @@ async function gh14003() {
   await TestModel.validate({ name: 'foo' }, { pathsToSkip: ['name'] });
 }
 
+async function gh14114() {
+  const schema = new mongoose.Schema({ name: String });
+  const Test = mongoose.model('Test', schema);
+
+  expectType<ReturnType<(typeof Test)['hydrate']> | null>(
+    await Test.findOneAndDelete({ name: 'foo' })
+  );
+}
+
 async function gh13999() {
   class RepositoryBase<T> {
     protected model: mongoose.Model<T>;
@@ -867,5 +876,4 @@ async function gh13999() {
       return elems;
     }
   }
-
 }
diff --git a/types/models.d.ts b/types/models.d.ts
@@ -612,11 +612,11 @@ declare module 'mongoose' {
       'findOneAndDelete'
     >;
     findOneAndDelete<ResultDoc = THydratedDocumentType>(
-      filter?: FilterQuery<TRawDocType>,
-      options?: QueryOptions<TRawDocType> & { includeResultMetadata: true }
+      filter: FilterQuery<TRawDocType>,
+      options: QueryOptions<TRawDocType> & { includeResultMetadata: true }
     ): QueryWithHelpers<ModifyResult<ResultDoc>, ResultDoc, TQueryHelpers, TRawDocType, 'findOneAndDelete'>;
     findOneAndDelete<ResultDoc = THydratedDocumentType>(
-      filter?: FilterQuery<TRawDocType>,
+      filter?: FilterQuery<TRawDocType> | null,
       options?: QueryOptions<TRawDocType> | null
     ): QueryWithHelpers<ResultDoc | null, ResultDoc, TQueryHelpers, TRawDocType, 'findOneAndDelete'>;