SetOptions extension type

An options object that configures the behavior of set() calls in DocumentReference, WriteBatch and Transaction. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety.

@param merge Changes the behavior of a set() call to only replace the values specified in its data argument. Fields omitted from the set() call remain untouched. If your input sets any field to an empty map, all nested fields are overwritten.

@param mergeFields Changes the behavior of set() calls to only replace the specified field paths. Any field path that is not specified is ignored and remains untouched. If your input sets any field to an empty map, all nested fields are overwritten.

on

• JSObject

Implemented types

• JSObject

Available extensions

• FirebaseJsInteropJSObjectExtension
• JSObjectUnsafeUtilExtension

Constructors

SetOptions({bool? merge, JSArray<JSAny>? mergeFields})

Constructor

Properties

hashCode → int

The hash code for this object.

no setter, inherited

merge → bool?

merge

no setter

mergeFields → JSArray<JSAny>?

merge fields

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited