GeoFirestore represents a Firestore Database and is the entry point for all GeoFirestore operations.
Creates a write batch, used for performing multiple writes as a single atomic operation.
Key to use for GeoPoints in a write batch.
GeoCollectionReference instance that refers to the collection at the specified path.
A slash-separated path to a collection.
Key to use for GeoPoints in a collection.
Creates and returns a new GeoQuery that includes all documents in the database that are contained in a collection or subcollection with the given collectionId.
Identifies the collections to query over. Every collection or subcollection with this ID as the last segment of its path will be included. Cannot contain a slash.
The created GeoQuery.
GeoDocumentReference instance that refers to the document at the
A slash-separated path to a document.
Executes the given updateFunction and then attempts to commit the changes applied within the transaction. If any document read within the transaction has changed, the updateFunction will be retried. If it fails to commit after 5 attempts, the transaction will fail.
updateFunction passed into
runTransaction is a standard Firestore transaction. You should then immediateley create a
GeoTransaction to then make your calls to. Below is a small example on how to do that.
The function to execute within the transaction context.
If the transaction completed successfully or was explicitly aborted (by the updateFunction returning a failed Promise), the Promise returned by the updateFunction will be returned here. Else if the transaction failed, a rejected Promise with the corresponding failure error will be returned.
Generated using TypeDoc