firebase-firestore/io.github.corneloaie.firebase.firestore.externals

Package-level declarations

Types

AggregateField

external interface AggregateField : JsAny

AggregateQuerySnapshot

external interface AggregateQuerySnapshot : JsAny

BsonObjectId

external class BsonObjectId(value: String) : JsAny

BsonTimestamp

external class BsonTimestamp(seconds: Double, increment: Double) : JsAny

Bytes

external class Bytes : JsAny

The Uint8Arrays are typed JsAny: this module does not depend on kotlinx-browser, which declares org.khronos.webgl for Kotlin/Wasm (see Values.wasmJs.kt for the conversions).

CollectionReference

external interface CollectionReference : Query

Decimal128Value

external class Decimal128Value(value: String) : JsAny

DocumentChange

external interface DocumentChange : JsAny

DocumentReference

external class DocumentReference : JsAny

DocumentSnapshot

external interface DocumentSnapshot : JsAny

FieldPath

external class FieldPath(fieldNames: String) : JsAny

FieldValue

external class FieldValue : JsAny

Firestore

external interface Firestore : JsAny

FirestoreLocalCache

external interface FirestoreLocalCache : JsAny

GeoPoint

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

Int32Value

external class Int32Value(value: Int) : JsAny

LoadBundleTask

external interface LoadBundleTask : JsAny

LoadBundleTaskProgress

external interface LoadBundleTaskProgress : JsAny

MaxKey

external class MaxKey : JsAny

MemoryCacheSettings

external interface MemoryCacheSettings : JsAny

MemoryEagerGarbageCollector

external interface MemoryEagerGarbageCollector : MemoryGarbageCollector

MemoryGarbageCollector

external interface MemoryGarbageCollector : JsAny

MemoryLocalCache

external interface MemoryLocalCache : FirestoreLocalCache

MemoryLruGarbageCollector

external interface MemoryLruGarbageCollector : MemoryGarbageCollector

MinKey

external class MinKey : JsAny

PersistentCacheIndexManager

external interface PersistentCacheIndexManager : JsAny

PersistentCacheSettings

external interface PersistentCacheSettings : JsAny

PersistentLocalCache

external interface PersistentLocalCache : FirestoreLocalCache

PersistentTabManager

external interface PersistentTabManager : JsAny

Query

external interface Query : JsAny

QueryConstraint

external interface QueryConstraint : JsAny

QuerySnapshot

external interface QuerySnapshot : JsAny

RegexValue

external class RegexValue(pattern: String, options: String) : JsAny

SnapshotMetadata

external interface SnapshotMetadata : JsAny

Timestamp

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

Transaction

external interface Transaction : JsAny

VectorValue

external class VectorValue : JsAny

WriteBatch

external interface WriteBatch : JsAny

Functions

addDoc

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

and

external fun and(vararg queryConstraints: QueryConstraint): QueryConstraint

arrayRemove

external fun arrayRemove(vararg elements: JsAny?): FieldValue

arrayUnion

external fun arrayUnion(vararg elements: JsAny?): FieldValue

average

external fun average(field: FieldPath): AggregateField

external fun average(field: String): AggregateField

clearIndexedDbPersistence

external fun clearIndexedDbPersistence(firestore: Firestore): Promise<JsAny?>

collection

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: JsAny? = definedExternally)

count

external fun count(): AggregateField

deleteAllPersistentCacheIndexes

external fun deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager)

deleteDoc

external fun deleteDoc(reference: DocumentReference): Promise<JsAny?>

deleteField

external fun deleteField(): FieldValue

disableNetwork

external fun disableNetwork(firestore: Firestore): Promise<JsAny?>

disablePersistentCacheIndexAutoCreation

external fun disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager)

doc

external fun doc(firestore: CollectionReference): DocumentReference

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

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

documentId

external fun documentId(): FieldPath

enableIndexedDbPersistence

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

enableNetwork

external fun enableNetwork(firestore: Firestore): Promise<JsAny?>

enablePersistentCacheIndexAutoCreation

external fun enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager)

endAt

external fun endAt(document: DocumentSnapshot): QueryConstraint

external fun endAt(vararg fieldValues: JsAny?): QueryConstraint

endBefore

external fun endBefore(document: DocumentSnapshot): QueryConstraint

external fun endBefore(vararg fieldValues: JsAny?): QueryConstraint

getAggregateFromServer

external fun getAggregateFromServer(query: Query, aggregateSpec: JsAny): Promise<AggregateQuerySnapshot>

getCountFromServer

external fun getCountFromServer(query: Query): Promise<AggregateQuerySnapshot>

getDoc

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

getDocFromCache

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

getDocFromServer

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

getDocs

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

getDocsFromCache

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

getDocsFromServer

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

getFirestore

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

getPersistentCacheIndexManager

external fun getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager?

increment

external fun increment(n: Double): FieldValue

external fun increment(n: Int): FieldValue

initializeFirestore

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

limit

external fun limit(limit: Int): QueryConstraint

limitToLast

external fun limitToLast(limit: Int): QueryConstraint

loadBundle

external fun loadBundle(firestore: Firestore, bundleData: JsAny): LoadBundleTask

maximum

external fun maximum(n: Double): FieldValue

memoryEagerGarbageCollector

external fun memoryEagerGarbageCollector(): MemoryEagerGarbageCollector

memoryLocalCache

external fun memoryLocalCache(settings: MemoryCacheSettings): MemoryLocalCache

memoryLruGarbageCollector

external fun memoryLruGarbageCollector(settings: JsAny? = definedExternally): MemoryLruGarbageCollector

minimum

external fun minimum(n: Double): FieldValue

namedQuery

external fun namedQuery(firestore: Firestore, name: String): Promise<Query?>

onSnapshot

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

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

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

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

onSnapshotsInSync

external fun onSnapshotsInSync(firestore: Firestore, onSync: () -> Unit): Unsubscribe

external fun or(vararg queryConstraints: QueryConstraint): QueryConstraint

orderBy

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

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

persistentLocalCache

external fun persistentLocalCache(settings: PersistentCacheSettings): PersistentLocalCache

persistentMultipleTabManager

external fun persistentMultipleTabManager(): PersistentTabManager

persistentSingleTabManager

external fun persistentSingleTabManager(settings: JsAny? = definedExternally): PersistentTabManager

query

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

queryEqual

external fun queryEqual(left: Query, right: Query): Boolean

refEqual

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

runTransaction

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

serverTimestamp

external fun serverTimestamp(): FieldValue

setDoc

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

setLogLevel

external fun setLogLevel(logLevel: String)

snapshotEqual

external fun snapshotEqual(left: JsAny, right: JsAny): Boolean

startAfter

external fun startAfter(document: DocumentSnapshot): QueryConstraint

external fun startAfter(vararg fieldValues: JsAny?): QueryConstraint

startAt

external fun startAt(document: DocumentSnapshot): QueryConstraint

external fun startAt(vararg fieldValues: JsAny?): QueryConstraint

sum

external fun sum(field: FieldPath): AggregateField

external fun sum(field: String): AggregateField

terminate

external fun terminate(firestore: Firestore): Promise<JsAny?>

updateDoc

external fun updateDoc(reference: DocumentReference, data: JsAny): Promise<JsAny?>

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

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

vector

external fun vector(values: JsArray<JsNumber>): VectorValue

waitForPendingWrites

external fun waitForPendingWrites(firestore: Firestore): Promise<JsAny?>

where

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

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

writeBatch

external fun writeBatch(firestore: Firestore): WriteBatch