feat(NODE-4774): deprecate cursor forEach (#3622)

mongodb · Apr 5, 2023 · 8d76a71 · 8d76a71
1 parent 2839e95
commit 8d76a71
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/src/cursor/abstract_cursor.ts b/src/cursor/abstract_cursor.ts
@@ -397,6 +397,7 @@ export abstract class AbstractCursor<
    * If the iterator returns `false`, iteration will stop.
    *
    * @param iterator - The iteration callback.
+   * @deprecated - Will be removed in a future release. Use for await...of instead.
    */
   async forEach(iterator: (doc: TSchema) => boolean | void): Promise<void> {
     if (typeof iterator !== 'function') {