https://github.com/Zhuinden/livedata-combinetuple-kt

[ACTIVE] Helper function to combine LiveData into tuples.
https://github.com/Zhuinden/livedata-combinetuple-kt

Last synced: 3 months ago
JSON representation

[ACTIVE] Helper function to combine LiveData into tuples.

• Host: GitHub
• URL: https://github.com/Zhuinden/livedata-combinetuple-kt
• Owner: Zhuinden
• License: apache-2.0
• Created: 2020-03-31T16:55:36.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-12-21T14:01:02.000Z (over 2 years ago)
• Last Synced: 2024-01-17T02:28:02.178Z (5 months ago)
• Language: Kotlin
• Size: 85.9 KB
• Stars: 85
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Lists

• awesome-list - Zhuinden/livedata-combinetuple-kt - [ACTIVE] Helper function to combine LiveData into tuples. (Kotlin)

README

        
# LiveData-CombineTuple-KT

LiveData-CombineTuple-KT contains helper functions for LiveData, to combine their latest emissions into typed tuples.

Under the hood, it uses Tuples-KT to help provide combiners from 2 to 16 arity.

``` kotlin

combineTuple(liveData1, liveData2, liveData3)

    .observe(lifecycleOwner) { (t1, t2, t3) ->

        // do something with combined livedata values

    }

```

## Why?

It's useful when you want to combine multiple reactive streams together and get a combined object of the latest values, without defining an actual class with an actual name to do it.

## Using LiveData-CombineTuple-KT

In order to use LiveData-CombineTuple-KT, you need to add `jitpack` to your project root `build.gradle.kts`

(or `build.gradle`):

``` kotlin

// build.gradle.kts

allprojects {

    repositories {

        // ...

        maven { setUrl("https://jitpack.io") }

    }

    // ...

}

```

or

``` groovy

// build.gradle

allprojects {

    repositories {

        // ...

        maven { url "https://jitpack.io" }

    }

    // ...

}

```

In newer projects, you need to also update the `settings.gradle` file's `dependencyResolutionManagement` block:

```

dependencyResolutionManagement {

    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)

    repositories {

        google()

        mavenCentral()

        maven { url 'https://jitpack.io' }  // <--

        jcenter() // Warning: this repository is going to shut down soon

    }

}

```

and then, add the dependency to your module's `build.gradle.kts` (or `build.gradle`):

``` kotlin

// build.gradle.kts

implementation("com.github.Zhuinden:livedata-combinetuple-kt:2.0.0")

```

or

``` groovy

// build.gradle

implementation 'com.github.Zhuinden:livedata-combinetuple-kt:2.0.0'

```

## License

    Copyright 2020 Gabor Varadi

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.