collectStarted() extension for contraction of repeatOnLifecycle(Lifecycle.State.STARTED)

CollectStarted.kt

import androidx.lifecycle.Lifecycle
import androidx.lifecycle.LifecycleOwner
import androidx.lifecycle.lifecycleScope
import androidx.lifecycle.repeatOnLifecycle
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.launch

/*
 * Contraction for:
 * https://developer.android.com/kotlin/flow/stateflow-and-sharedflow
 */
fun <T> LifecycleOwner.collectStarted(flow: Flow<T>, collector: (T) -> Unit) {
    lifecycleScope.launch {
        // repeatOnLifecycle launches the block in a new coroutine every time the
        // lifecycle is in the STARTED state (or above) and cancels it when it's STOPPED.
        repeatOnLifecycle(Lifecycle.State.STARTED) {
            // Trigger the flow and start listening for values.
            // Note that this happens when lifecycle is STARTED and stops
            // collecting when the lifecycle is STOPPED
            flow.collect { uiState ->
                // New value received
                collector(uiState)
            }
        }
    }
}

/*
 * In case of Fragment must be called in onViewCreated() stage:
 *
 * viewModel.someState.collectStarted(viewLifecycleOwner) { ... }
 */
fun <T> Flow<T>.collectStarted(lifecycleOwner: LifecycleOwner, collector: (T) -> Unit) {
    lifecycleOwner.collectStarted(this, collector)
}