Merge pull request #14798 from Automattic/vkarpov15/gh-14787

types(cursor): indicate that cursor.next() can return null
Automattic · Aug 10, 2024 · 4fa87e9 · 4fa87e9
2 parents 5d6463b + 2b4b2f9
commit 4fa87e9
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/test/types/querycursor.test.ts b/test/types/querycursor.test.ts
@@ -21,6 +21,8 @@ Test.find().cursor().
   }).
   then(() => console.log('Done!'));
 
+Test.find().cursor().next().then((doc) => expectType<ITest | null>(doc));
+
 async function gh14374() {
   // `Parent` represents the object as it is stored in MongoDB
   interface Parent {

diff --git a/types/cursor.d.ts b/types/cursor.d.ts
@@ -51,7 +51,7 @@ declare module 'mongoose' {
      * Get the next document from this cursor. Will return `null` when there are
      * no documents left.
      */
-    next(): Promise<DocType>;
+    next(): Promise<DocType | null>;
 
     options: Options;
   }