The WriteBatch instance.
Key to use for GeoPoints in a write batch.
The native WriteBatch instance.
Commits all of the writes in this write batch as a single atomic unit.
A Promise resolved once all of the writes in the batch have been successfully written to the backend as an atomic unit. Note that it won't resolve while you're offline.
Deletes the document referred to by the provided DocumentReference or GeoDocumentReference.
A reference to the document to be deleted.
This WriteBatch instance. Used for chaining method calls.
Writes to the document referred to by the provided DocumentReference or GeoDocumentReference. If the document does not exist yet,
it will be created. If you pass SetOptions, the provided data can be merged into the existing document.
A reference to the document to be set.
An object of the fields and values for the document.
An object to configure the set behavior. Includes custom key for location in document.
This GeoWriteBatch instance. Used for chaining method calls.
Updates fields in the document referred to by the provided DocumentReference or GeoDocumentReference. The update will fail if
applied to a document that does not exist.
A reference to the document to be updated.
An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.
The key of the document to use as the location. Otherwise we default to coordinates.
This GeoWriteBatch instance. Used for chaining method calls.
Generated using TypeDoc
A write batch, used to perform multiple writes as a single atomic unit.
A
GeoWriteBatchobject can be acquired by callingGeoFirestore.batch(). It provides methods for adding writes to the write batch. None of the writes will be committed (or visible locally) untilGeoWriteBatch.commit()is called.Unlike transactions, write batches are persisted offline and therefore are preferable when you don't need to condition your writes on read data.