-
Notifications
You must be signed in to change notification settings - Fork 1.8k
docs(NODE-6456): document CSOT pt 1 #4292
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Question: Did we want to mark the CSOT options as public or as experimental for the release? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
I just fixed a bit of formatting: public tags on a new line, example tags directly proceed code snippets.
I also fixed our timeoutMode enum not exported from the top-level index file, and added "type" exports to 'AnyBulkWriteOperation', 'BulkWriteOptions' which fix an outstanding erroneous issue where when loaded with ts-node those appear as "undefined" exports.
The diff on the EXPECTED_EXPORTS may look strange, I alphabetized it to make 👁️ eye inspection a bit easier.
Also, let's add in the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your quick response on this PR! I think there's a few more missing @experimental
tags and I asked for a some more clarification on the index.test.ts
changes
Co-authored-by: Neal Beeken <[email protected]> Co-authored-by: Aditi Khare <[email protected]>
Co-authored-by: Neal Beeken <[email protected]> Co-authored-by: Aditi Khare <[email protected]>
Description
What is changing?
timeoutMS
andtimeoutMode
optionsCursorTimeoutMode
timeoutMS
andtimeoutMode
publicIs there new documentation needed for these changes?
What is the motivation for this change?
Release Highlight
Double check the following
npm run check:lint
scripttype(NODE-xxxx)[!]: description
feat(NODE-1234)!: rewriting everything in coffeescript