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

durran · web-flow · commit 8d76a7173fb8 · 2023-04-05T13:05:21.000-04:00
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') {

Original file line number	Diff line number	Diff line change
`@@ -397,6 +397,7 @@ export abstract class AbstractCursor<`
`397`	`397`	* If the iterator returns `false`, iteration will stop.
`398`	`398`	`*`
`399`	`399`	`* @param iterator - The iteration callback.`
	`400`	`+ * @deprecated - Will be removed in a future release. Use for await...of instead.`
`400`	`401`	`*/`
`401`	`402`	`async forEach(iterator: (doc: TSchema) => boolean \| void): Promise<void> {`
`402`	`403`	`if (typeof iterator !== 'function') {`