-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
feat(NODE-6252): insertMany and bulkWrite permit readonly arrays #4175
Merged
Conversation
This file contains 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
baileympearson
added
the
Primary Review
In Review with primary reviewer, not yet ready for team's eyes
label
Jul 15, 2024
baileympearson
approved these changes
Jul 15, 2024
This was referenced Oct 3, 2024
This was referenced Oct 5, 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?
insertMany
andbulkWrite
on the Collection class accept readonly arraysIs there new documentation needed for these changes?
No
What is the motivation for this change?
Readonly data structures in TS can be narrowed and index checked, improving DX.
Release Highlight
insertMany
andbulkWrite
accept ReadonlyArray inputsThis improves the typescript developer expirence, developers tend to use ReadonlyArray because it can help understand where mutations are made and when enabling
noUncheckedIndexedAccess
leads to a better type narrowing expirence.Please note, that the array is readonly but not the documents, the driver adds
_id
fields to your documents unless you request that the server generate the_id
withforceServerObjectId
Double check the following
npm run check:lint
scripttype(NODE-xxxx)[!]: description
feat(NODE-1234)!: rewriting everything in coffeescript