feat(NODE-5429): deprecate the AutoEncrypter interface (#3764)

mongodb · Jul 10, 2023 · 9bb0d95 · 9bb0d95
1 parent cd923c8
commit 9bb0d95
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/src/deps.ts b/src/deps.ts
@@ -396,7 +396,10 @@ export interface AutoEncryptionOptions {
   };
 }
 
-/** @public */
+/**
+ * @public
+ * @deprecated This interface will be removed in the next major version.
+ */
 export interface AutoEncrypter {
   // eslint-disable-next-line @typescript-eslint/no-misused-new
   new (client: MongoClient, options: AutoEncryptionOptions): AutoEncrypter;

diff --git a/src/mongo_client.ts b/src/mongo_client.ts
@@ -417,6 +417,9 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> {
     this[kOptions].monitorCommands = value;
   }
 
+  /**
+   * @deprecated This method will be removed in the next major version.
+   */
   get autoEncrypter(): AutoEncrypter | undefined {
     return this[kOptions].autoEncrypter;
   }
@@ -780,6 +783,9 @@ export interface MongoOptions
   writeConcern: WriteConcern;
   dbName: string;
   metadata: ClientMetadata;
+  /**
+   * @deprecated This option will be removed in the next major version.
+   */
   autoEncrypter?: AutoEncrypter;
   proxyHost?: string;
   proxyPort?: number;