docs(NODE-6458): document CSOT for explicit encryption #4302
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aditi-khare-mongoDB
suggested changes
Oct 31, 2024
| * ``` | ||
| * | ||
| * If `timeoutMS` is configured on the provided client, the client's timeoutMS value | ||
| * will be used unless `timeoutMS` is also provided as a separate option. |
There was a problem hiding this comment.
Suggested change
| * will be used unless `timeoutMS` is also provided as a separate option. | |
| * will be used unless `ClientEncryptionOptions.timeoutMS` is also provided as a separate option. |
This is a bit clearer to me considering we're using timeoutMS to refer to both ClientEncryptionOptions.timeoutMS and MongoClient.options.timeoutMS
| * ```typescript | ||
| * const client = new MongoClient('<uri>', { timeoutMS: 2_000 }); | ||
| * | ||
| * // timeoutMS is set to 1_000 |
There was a problem hiding this comment.
Suggested change
| * // timeoutMS is set to 1_000 | |
| * // clientEncryptionOptions.timeoutMS overrides the client's timeoutMS and 1_000 is used as the timeoutMS for the ClientEncryption object |
| * await clientEncryption.createDataKey('local'); | ||
| * ``` | ||
| * | ||
| * If `timeoutMS` is configured on the provided client, the client's timeoutMS value |
There was a problem hiding this comment.
``
Suggested change
| * If `timeoutMS` is configured on the provided client, the client's timeoutMS value | |
| * If `timeoutMS` is configured on the provided client, the client's `timeoutMS` value |
aditi-khare-mongoDB
added
the
Primary Review
baileympearson
force-pushed
the
document-fle
branch
from
bcbc1de to
4540cfc
Compare
aditi-khare-mongoDB
approved these changes
Nov 1, 2024
nbbeeken
pushed a commit
that referenced
this pull request
Nov 5, 2024
dariakp
pushed a commit
that referenced
this pull request
Nov 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
What is changing?
Is there new documentation needed for these changes?
What is the motivation for this change?
Release Highlight
Fill in title or leave empty for no highlight
Double check the following
npm run check:lintscripttype(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript