docs: improve documentation for merge behavior #1648
Merged
+54
−17
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
product-auto-label
bot
added
the
api: firestore
thebrianchen
approved these changes
Dec 22, 2021
dev/src/bulk-writer.ts
Outdated
| * @param {Array.<string|FieldPath>=} options.mergeFields - If provided, set() | ||
| * only replaces the specified field paths. Any field path that is not | ||
| * specified is ignored and remains untouched. | ||
| * specified is ignored and remains untouched. If your input sets any field to | ||
| * an empty map, all nested fields at this location are overwritten. |
There was a problem hiding this comment.
I was initially confused since I inferred "location" to mean the document being set. The ambiguous interpretations:
- all nested fields in the document location are overwritten with empty map, but top level fields remain
- if the specified field has a nested field, it's deleted, but if the specified field maps to a value, it's not.
alternative suggestion: "if your input sets any field to an empty map, the specified field is (overwritten/set to) an empty map.
There was a problem hiding this comment.
You are right, this is a bit confusing. I don't like how your example uses "empty map" twice, but I think we can achieve the same by just removing "at this location". What do you think?
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.
Fixes firebase/firebase-admin-node#987