firebase-firestore

2.3.0

firebase-firestore/dev.gitlive.firebase.firestore.externals

Package-level declarations

Types

CollectionReference

external interface CollectionReference : Query

external interface DocumentChange

DocumentReference

external class DocumentReference

DocumentSnapshot

external interface DocumentSnapshot

external class FieldPath(fieldNames: String)

external class FieldValue

external interface Firestore

FirestoreLocalCache

external interface FirestoreLocalCache

external class GeoPoint(latitude: Double, longitude: Double)

MemoryCacheSettings

external interface MemoryCacheSettings

MemoryEagerGarbageCollector

external interface MemoryEagerGarbageCollector : MemoryGarbageCollector

MemoryGarbageCollector

external interface MemoryGarbageCollector

MemoryLocalCache

external interface MemoryLocalCache : FirestoreLocalCache

MemoryLruGarbageCollector

external interface MemoryLruGarbageCollector : MemoryGarbageCollector

PersistentCacheSettings

external interface PersistentCacheSettings

PersistentLocalCache

external interface PersistentLocalCache : FirestoreLocalCache

PersistentTabManager

external interface PersistentTabManager

external interface Query

QueryConstraint

external interface QueryConstraint

external interface QuerySnapshot

SnapshotMetadata

external interface SnapshotMetadata

external class Timestamp(seconds: Double, nanoseconds: Double)

external interface Transaction

external interface WriteBatch

Functions

external fun addDoc(reference: CollectionReference, data: Any): Promise<DocumentReference>

external fun and(vararg queryConstraints: QueryConstraint): QueryConstraint

external fun arrayRemove(vararg elements: Any): FieldValue

external fun arrayUnion(vararg elements: Any): FieldValue

clearIndexedDbPersistence

external fun clearIndexedDbPersistence(firestore: Firestore): Promise<Unit>

external fun collection(reference: DocumentReference, collectionPath: String): CollectionReference

external fun collection(firestore: Firestore, collectionPath: String): CollectionReference

collectionGroup

external fun collectionGroup(firestore: Firestore, collectionId: String): Query

connectFirestoreEmulator

external fun connectFirestoreEmulator(firestore: Firestore, host: String, port: Int, options: Any? = definedExternally)

external fun deleteDoc(reference: DocumentReference): Promise<Unit>

external fun deleteField(): FieldValue

external fun disableNetwork(firestore: Firestore): Promise<Unit>

external fun doc(firestore: CollectionReference, documentPath: String? = definedExternally): DocumentReference

external fun doc(firestore: Firestore, documentPath: String): DocumentReference

external fun documentId(): FieldPath

enableIndexedDbPersistence

external fun enableIndexedDbPersistence(firestore: Firestore, persistenceSettings: Any? = definedExternally): Promise<Unit>

external fun enableNetwork(firestore: Firestore): Promise<Unit>

external fun endAt(document: DocumentSnapshot): QueryConstraint

external fun endAt(vararg fieldValues: Any): QueryConstraint

external fun endBefore(document: DocumentSnapshot): QueryConstraint

external fun endBefore(vararg fieldValues: Any): QueryConstraint

external fun getDoc(reference: DocumentReference, options: Any? = definedExternally): Promise<DocumentSnapshot>

getDocFromCache

external fun getDocFromCache(reference: DocumentReference): Promise<DocumentSnapshot>

getDocFromServer

external fun getDocFromServer(reference: DocumentReference): Promise<DocumentSnapshot>

external fun getDocs(query: Query): Promise<QuerySnapshot>

getDocsFromCache

external fun getDocsFromCache(query: Query): Promise<QuerySnapshot>

getDocsFromServer

external fun getDocsFromServer(query: Query): Promise<QuerySnapshot>

external fun getFirestore(app: FirebaseApp? = definedExternally, databaseId: String? = definedExternally): Firestore

external fun increment(n: Int): FieldValue

initializeFirestore

external fun initializeFirestore(app: FirebaseApp, settings: dynamic = definedExternally, databaseId: String? = definedExternally): Firestore

external fun limit(limit: Number): QueryConstraint

memoryEagerGarbageCollector

external fun memoryEagerGarbageCollector(): MemoryEagerGarbageCollector

memoryLocalCache

external fun memoryLocalCache(settings: MemoryCacheSettings): MemoryLocalCache

memoryLruGarbageCollector

external fun memoryLruGarbageCollector(settings: dynamic = definedExternally): MemoryLruGarbageCollector

external fun onSnapshot(reference: DocumentReference, next: (snapshot: DocumentSnapshot) -> Unit, error: (error: Throwable) -> Unit): Unsubscribe

external fun onSnapshot(reference: Query, next: (snapshot: QuerySnapshot) -> Unit, error: (error: Throwable) -> Unit): Unsubscribe

external fun onSnapshot(reference: DocumentReference, options: Json, next: (snapshot: DocumentSnapshot) -> Unit, error: (error: Throwable) -> Unit): Unsubscribe

external fun onSnapshot(reference: Query, options: Json, next: (snapshot: QuerySnapshot) -> Unit, error: (error: Throwable) -> Unit): Unsubscribe

external fun or(vararg queryConstraints: QueryConstraint): QueryConstraint

external fun orderBy(field: FieldPath, direction: Any): QueryConstraint

external fun orderBy(field: String, direction: Any): QueryConstraint

persistentLocalCache

external fun persistentLocalCache(settings: PersistentCacheSettings): PersistentLocalCache

persistentMultipleTabManager

external fun persistentMultipleTabManager(): PersistentTabManager

persistentSingleTabManager

external fun persistentSingleTabManager(settings: dynamic = definedExternally): PersistentTabManager

external fun query(query: Query, vararg queryConstraints: QueryConstraint): Query

external fun refEqual(left: DocumentReference, right: DocumentReference): Boolean

external fun <T> runTransaction(firestore: Firestore, updateFunction: (transaction: Transaction) -> Promise<T>, options: Any? = definedExternally): Promise<T>

serverTimestamp

external fun serverTimestamp(): FieldValue

external fun setDoc(documentReference: DocumentReference, data: Any, options: Any? = definedExternally): Promise<Unit>

external fun setLogLevel(logLevel: String)

external fun startAfter(document: DocumentSnapshot): QueryConstraint

external fun startAfter(vararg fieldValues: Any): QueryConstraint

external fun startAt(document: DocumentSnapshot): QueryConstraint

external fun startAt(vararg fieldValues: Any): QueryConstraint

external fun updateDoc(reference: DocumentReference, data: Any): Promise<Unit>

external fun updateDoc(reference: DocumentReference, field: FieldPath, value: Any?, vararg moreFieldsAndValues: Any?): Promise<Unit>

external fun updateDoc(reference: DocumentReference, field: String, value: Any?, vararg moreFieldsAndValues: Any?): Promise<Unit>

external fun where(field: FieldPath, opStr: String, value: Any?): QueryConstraint

external fun where(field: String, opStr: String, value: Any?): QueryConstraint

external fun writeBatch(firestore: Firestore): WriteBatch