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

noahsilas · web-flow · commit dbfb7d5b38c4 · 2022-10-12T09:06:30.000-07:00
This undocumented behavior is surprising. Adding a note here may help
future users.
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.
    */

Original file line number	Diff line number	Diff line change
`@@ -400,6 +400,8 @@ export abstract class AbstractCursor<`
`400`	`400`	`/**`
`401`	`401`	`* Iterates over all the documents for this cursor using the iterator, callback pattern.`
`402`	`402`	`*`
	`403`	+ * If the iterator returns `false`, iteration will stop.
	`404`	`+ *`
`403`	`405`	`* @param iterator - The iteration callback.`
`404`	`406`	`* @param callback - The end callback.`
`405`	`407`	`*/`