feat(NODE-4733): deprecate result and getLastOp (#3458)

mongodb · Nov 7, 2022 · a143d3b · a143d3b
1 parent bf7a132
commit a143d3b
Showing 1 changed file with 12 additions and 2 deletions.
diff --git a/src/bulk/common.ts b/src/bulk/common.ts
@@ -130,7 +130,11 @@ export type AnyBulkWriteOperation<TSchema extends Document = Document> =
   | { deleteOne: DeleteOneModel<TSchema> }
   | { deleteMany: DeleteManyModel<TSchema> };
 
-/** @public */
+/**
+ * @public
+ *
+ * @deprecated Will be made internal in 5.0
+ */
 export interface BulkResult {
   ok: number;
   writeErrors: WriteError[];
@@ -176,6 +180,7 @@ export class Batch<T = Document> {
  * The result of a bulk write.
  */
 export class BulkWriteResult {
+  /** @deprecated Will be removed in 5.0 */
   result: BulkResult;
 
   /**
@@ -295,7 +300,11 @@ export class BulkWriteResult {
     return this.result.writeErrors;
   }
 
-  /** Retrieve lastOp if available */
+  /**
+   * Retrieve lastOp if available
+   *
+   * @deprecated Will be removed in 5.0
+   */
   getLastOp(): Document | undefined {
     return this.result.opTime;
   }
@@ -322,6 +331,7 @@ export class BulkWriteResult {
     }
   }
 
+  /* @deprecated Will be removed in 5.0 release */
   toJSON(): BulkResult {
     return this.result;
   }