chore: add note for API docs

durran · durran · commit 42915956cdb3 · 2025-07-22T22:43:43.000+02:00
diff --git a/src/client-side-encryption/state_machine.ts b/src/client-side-encryption/state_machine.ts
@@ -103,6 +103,8 @@ declare module 'mongodb-client-encryption' {
  *  - tlsInsecure
  *
  * These options are not included in the type, and are ignored if provided.
+ *
+ * Note that if a secureContext option is provided, all other TLS options will be ignored.
  */
 export type ClientEncryptionTlsOptions = Pick<
   MongoClientOptions,

Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,8 @@ declare module 'mongodb-client-encryption' {`
`103`	`103`	`* - tlsInsecure`
`104`	`104`	`*`
`105`	`105`	`* These options are not included in the type, and are ignored if provided.`
	`106`	`+ *`
	`107`	`+ * Note that if a secureContext option is provided, all other TLS options will be ignored.`
`106`	`108`	`*/`
`107`	`109`	`export type ClientEncryptionTlsOptions = Pick<`
`108`	`110`	`MongoClientOptions,`