The CollectionReference instance.
Key to use for GeoPoints in a collection.
Returns the center and radius of geo based queries as a QueryCriteria object.
The Firestore for the Firestore database (useful for performing transactions, etc.).
The identifier of the collection.
The native CollectionReference instance.
Attaches a listener for GeoQuerySnapshot events.
An unsubscribe function that can be called to cancel the snapshot listener.
Attaches a listener for GeoQuerySnapshot events.
A callback to be called every time a new GeoQuerySnapshot is available.
A callback to be called if the listen fails or is cancelled. Since multuple queries occur only the failed query will cease.
An unsubscribe function that can be called to cancel the snapshot listener.
A reference to the containing Document if this is a subcollection, else null.
A string representing the path of the referenced collection (relative to the root of the database).
Add a new document to this collection with the specified data, assigning it a document ID automatically.
An Object containing the data for the new document.
The key of the document to use as the location. Otherwise we default to coordinates.
A Promise resolved with a GeoDocumentReference pointing to the newly created document after it has been written to the
backend.
Get a GeoDocumentReference for the document within the collection at the specified path. If no path is specified, an
automatically-generated unique ID will be used for the returned GeoDocumentReference.
A slash-separated path to a document.
The GeoDocumentReference instance.
Executes the query and returns the results as a GeoQuerySnapshot.
WEB CLIENT ONLY
Note: By default, get() attempts to provide up-to-date data when possible by waiting for data from the server, but it may return
cached data or fail if you are offline and the server cannot be reached. This behavior can be altered via the GetOptions parameter.
An object to configure the get behavior.
A Promise that will be resolved with the results of the GeoQuery.
Creates and returns a new GeoQuery that's additionally limited to only return up to the specified number of documents.
This function returns a new (immutable) instance of the GeoQuery (rather than modify the existing instance) to impose the limit.
Note: Limits on geoqueries are applied based on the distance from the center. Geoqueries require an aggregation of queries. When performing a geoquery the library applies the limit on the client. This may mean you are loading to the client more documents then you intended. Use with this performance limitation in mind.
The maximum number of items to return.
The created GeoQuery.
Creates and returns a new GeoQuery with the geoquery filter where get and onSnapshot will query around.
This function returns a new (immutable) instance of the GeoQuery (rather than modify the existing instance) to impose the filter.
The created GeoQuery.
Creates and returns a new GeoQuery with the additional filter that documents must contain the specified field and that its value should satisfy the relation constraint provided.
This function returns a new (immutable) instance of the GeoQuery (rather than modify the existing instance) to impose the filter.
The path to compare
The operation string (e.g "<", "<=", "==", ">", ">=").
The value for comparison
The created GeoQuery.
Generated using TypeDoc
A
GeoCollectionReferenceobject can be used for adding documents, getting document references, and querying for documents (using the methods inherited fromGeoQuery).