Skip to content

Commit 026d591

Browse files
specify inheritence
1 parent d3c9cd4 commit 026d591

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/client-side-encryption/client_encryption.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -882,6 +882,19 @@ export interface ClientEncryptionOptions {
882882
* // `1_000` is used as the timeout for createDataKey call
883883
* await clientEncryption.createDataKey('local');
884884
* ```
885+
*
886+
* If `timeoutMS` is configured on the provided client, the client's timeoutMS value
887+
* will be used unless `timeoutMS` is also provided as a separate option.
888+
*
889+
* ```typescript
890+
* const client = new MongoClient('<uri>', { timeoutMS: 2_000 });
891+
*
892+
* // timeoutMS is set to 1_000
893+
* const clientEncryption = new ClientEncryption(client, {
894+
* timeoutMS: 1_000
895+
* kmsProviders: { local: { key: '<KEY>' } }
896+
* });
897+
* ```
885898
*/
886899
timeoutMS?: number;
887900
}

0 commit comments

Comments
 (0)