Skip to content

Commit d3c9cd4

Browse files
document
1 parent 88c5368 commit d3c9cd4

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

src/client-side-encryption/client_encryption.ts

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -866,9 +866,22 @@ export interface ClientEncryptionOptions {
866866
*/
867867
tlsOptions?: CSFLEKMSTlsOptions;
868868

869-
/** @internal TODO(NODE-5688): make this public
869+
/**
870870
*
871871
* The timeout setting to be used for all the operations on ClientEncryption.
872+
*
873+
* When provided, `timeoutMS` is used as the timeout for each operation executed on
874+
* the ClientEncryption object. For example:
875+
*
876+
* ```typescript
877+
* const clientEncryption = new ClientEncryption(client, {
878+
* timeoutMS: 1_000
879+
* kmsProviders: { local: { key: '<KEY>' } }
880+
* });
881+
*
882+
* // `1_000` is used as the timeout for createDataKey call
883+
* await clientEncryption.createDataKey('local');
884+
* ```
872885
*/
873886
timeoutMS?: number;
874887
}

0 commit comments

Comments
 (0)