chore: add note for API docs

durran · durran · commit a833c73419d0 · 2025-07-11T12:15:54.000-04:00
diff --git a/src/client-side-encryption/state_machine.ts b/src/client-side-encryption/state_machine.ts
@@ -108,6 +108,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
`@@ -108,6 +108,8 @@ declare module 'mongodb-client-encryption' {`
`108`	`108`	`* - tlsInsecure`
`109`	`109`	`*`
`110`	`110`	`* These options are not included in the type, and are ignored if provided.`
	`111`	`+ *`
	`112`	`+ * Note that if a secureContext option is provided, all other TLS options will be ignored.`
`111`	`113`	`*/`
`112`	`114`	`export type ClientEncryptionTlsOptions = Pick<`
`113`	`115`	`MongoClientOptions,`