docs: Note special case in AbstractCursor.forEach() iterator (#3445)

This undocumented behavior is surprising. Adding a note here may help future users.
mongodb · Oct 12, 2022 · dbfb7d5 · dbfb7d5
1 parent bf000ae
commit dbfb7d5
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/cursor/abstract_cursor.ts b/src/cursor/abstract_cursor.ts
@@ -400,6 +400,8 @@ export abstract class AbstractCursor<
   /**
    * Iterates over all the documents for this cursor using the iterator, callback pattern.
    *
+   * If the iterator returns `false`, iteration will stop.
+   *
    * @param iterator - The iteration callback.
    * @param callback - The end callback.
    */