geofirestore
Version:
Location-based querying and filtering using Firebase's Firestore
16 lines (15 loc) • 786 B
TypeScript
import { GeoFirestoreTypes } from 'geofirestore-core';
import { GeoFirestore } from './GeoFirestore';
/**
* Initializes GeoFirestore instance.
* @param firestore Firestore represents a Firestore Database and is the entry point for all Firestore operations.
* @return GeoFirestore instance.
*/
export declare function initializeApp(firestore: GeoFirestoreTypes.web.Firestore | GeoFirestoreTypes.cloud.Firestore): GeoFirestore;
/**
* Remove customKey attribute so firestore doesn't' reject.
*
* @param customKey The key of the document to use as the location. Otherwise we default to `coordinates`.
* @return The same object but without custom key
*/
export declare function sanitizeSetOptions(options: GeoFirestoreTypes.SetOptions): GeoFirestoreTypes.SetOptions;