Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: improve documentation for merge behavior #5828

Merged
merged 2 commits into from Dec 22, 2021
Merged

docs: improve documentation for merge behavior #5828

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01b0448
docs: improve documentation for merge behavior
schmidt-sebastian Dec 21, 2021
67afa76
Update reference.ts
schmidt-sebastian Dec 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/firestore/src/lite-api/reference.ts
View file
Open in desktop
Expand Up @@ -93,10 +93,12 @@ export type UpdateData<T> = T extends Primitive
*
* @param merge - Changes the behavior of a `setDoc()` call to only replace the
* values specified in its data argument. Fields omitted from the `setDoc()`
* call remain untouched.
* call remain untouched. If your input sets any field to an empty map, all
* nested fields are overwritten.
* @param mergeFields - Changes the behavior of `setDoc()` calls to only replace
* the specified field paths. Any field path that is not specified is ignored
* and remains untouched.
* and remains untouched. If your input sets any field to an empty map, all
* nested fields are overwritten.
*/
export type SetOptions =
| {
Expand Down