File tree Expand file tree Collapse file tree 1 file changed +14
-1
lines changed
src/client-side-encryption Expand file tree Collapse file tree 1 file changed +14
-1
lines changed Original file line number Diff line number Diff line change @@ -866,9 +866,22 @@ export interface ClientEncryptionOptions {
866
866
*/
867
867
tlsOptions ?: CSFLEKMSTlsOptions ;
868
868
869
- /** @internal TODO(NODE-5688): make this public
869
+ /**
870
870
*
871
871
* 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
+ * ```
872
885
*/
873
886
timeoutMS ?: number ;
874
887
}
You can’t perform that action at this time.
0 commit comments