RxFirestoreKt

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

★ 31 Open GitHub ↗

A set of extension functions to wrap Firebase's Firestore Android SDK with RxJava sugar

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[ ![Download](https://api.bintray.com/packages/aaronoe/android/RxFirestoreKt/images/download.svg) ](https://bintray.com/aaronoe/android/RxFirestoreKt/_latestVersion)

# RxFirestoreKt
A set of extension functions to wrap Firebase's Firestore Android SDK with RxJava sugar.

Usage
-----
Extension functions are available for the following types from Firestore:
- `DocumentReference`
- `CollectionReference`
- `Query`
- `FirebaseFirestore`

Call the methods `getObservable()`, `getFlowable()` and `getSingle` on `CollectionReference`, `Query` or `DocumentReference` 
to get one-time values or subscribtions to those rerferences/queries.
The firestore-listener is cancelled when the disposable is disposed.

```kotlin
val collectionReference = FirebaseFirestore.getInstance().collection("USERS")

val disposable = collectionReference.getObservable<User>()
        .subscribeOn(Schedulers.io())
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe({ userList ->
            // do stuff here
        }, { exception ->
            // exception handling
        })
```

Download
--------
Maven:
```xml
<dependency>
  <groupId>de.aaronoe</groupId>
  <artifactId>rxfirestorekt</artifactId>
  <version>0.1.1</version>
  <type>pom</type>
</dependency>
```
or Gradle:
```groovy
compile 'de.aaronoe:rxfirestorekt:0.1.1'
```

All Available Extensions
-----
```kotlin
val collectionReference = FirebaseFirestore.getInstance().collection("USERS")
val userDocumentReference = collectionReference.document("unique-user-id")
val usersQuery = collectionReference.whereEqualTo("userName", "test")

val usersObservable: Observable<List<User>> = collectionReference.getObservable<User>()
val usersFlowable: Flowable<List<User>> = collectionReference.getFlowable<User>(BackpressureStrategy.LATEST)
val usersSingle: Single<List<User>> = collectionReference.getSingle<User>()

val queryObservable = usersQuery.getObservable<User>()
val queryFlowable = usersQuery.getFlowable<User>(BackpressureStrategy.LATEST)
val querySingle = usersQuery.getSingle<User>()

val userObservable: Observable<User> = userDocumentReference.getObservable<User>()
val userSingle: Single<User> = userDocumentReference.getSingle<User>()
val userFlowable: Flowable<User> = userDocumentReference.getFlowable<User>(BackpressureStrategy.LATEST)

val setUserCompletable: Completable = userDocumentReference.setDocument(User("username", "userid", 0))
val addUserSingle: Single<DocumentReference> = collectionReference.addDocumentSingle(User("username", "userid", 0))
val deletedDocument: Completable = userDocumentReference.deleteDocument()

val updateCompletable: Completable = userDocumentReference.updateDocumentCompletable("userName", "newvalue")

val updateMap = HashMap<String, String>().apply {
    put("userName", "newvalue")
    put("userId", "newvalue")
}
val updateCompletableMap: Completable = userDocumentReference.updateDocumentCompletable(updateMap)

val incrementValue: Single<Long> = userDocumentReference.incrementField("followerCount", 1)

val transaction: Single<String> = FirebaseFirestore.getInstance().runTransactionSingle(Transaction.Function<String> {
    it.set(userDocumentReference, User("username", "userid", 0))
    it.update(userDocumentReference, "userName", "test123")
    it.get(userDocumentReference).get("userName") as String
})
```

License
=======
        MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.

RxFirestoreKt

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README