reactivestate-core/com.ensody.reactivestate/ReactiveViewModel

ReactiveViewModel

abstract class ReactiveViewModel(val scope: CoroutineScope) : CoroutineLauncher

Base class for ViewModels.

The scope is meant to be filled with ContextualVal entries.

For example, the ContextualOnInit hook can be used to launch coroutines via a CoroutineLauncher directly from the ViewModel constructor, so you can have nicer error handling and loading indicators.

Constructors

ReactiveViewModel

constructor(scope: CoroutineScope)

Properties

open override val loading: MutableStateFlow<Int>

The default loading tracker.

onInit

@ExperimentalReactiveStateApi

val CoroutineLauncher.onInit: OnInit

scope

override val scope: CoroutineScope

The underlying CoroutineScope of this launcher.

Functions

autoRun

fun CoroutineLauncher.autoRun(onChange: AutoRunOnChangeCallback<Unit>? = null, observer: AutoRunCallback<Unit>): AutoRunner<Unit>

Watches observables for changes. Often useful to keep things in sync (e.g. CoroutineLauncher -> UI).

coAutoRun

fun CoroutineLauncher.coAutoRun(onChange: CoAutoRunOnChangeCallback<Unit>? = null, flowTransformer: AutoRunFlowTransformer = { conflatedWorker(transform = it) }, dispatcher: CoroutineDispatcher = dispatchers.main, withLoading: MutableStateFlow<Int>? = loading, observer: CoAutoRunCallback<Unit>): CoAutoRunner<Unit>

Watches observables for changes. Often useful to keep things in sync (e.g. CoroutineLauncher -> UI).

derived

fun <T> CoroutineLauncher.derived(synchronous: Boolean = true, cache: Boolean = synchronous, observer: AutoRunCallback<T>): StateFlow<T>

Creates a StateFlow that computes its value based on other StateFlows via an autoRun block.

fun <T> CoroutineLauncher.derived(initial: T, started: SharingStarted = SharingStarted.Eagerly, flowTransformer: AutoRunFlowTransformer = { conflatedWorker(transform = it) }, dispatcher: CoroutineDispatcher = dispatchers.main, withLoading: MutableStateFlow<Int>? = loading, observer: CoAutoRunCallback<T>): StateFlow<T>

Creates a StateFlow that computes its value based on other StateFlows via a suspendable coAutoRun block.

invokeOnCompletion

fun CoroutineLauncher.invokeOnCompletion(handler: CompletionHandler): Disposable

Helper for adding a completion handler to a CoroutineLauncher.

launch

open fun launch(context: CoroutineContext = EmptyCoroutineContext, start: CoroutineStart = CoroutineStart.DEFAULT, withLoading: MutableStateFlow<Int>? = loading, onError: suspend (Throwable) -> Unit? = null, block: suspend CoroutineScope.() -> Unit): Job

Launches a coroutine. Mark long-running coroutines by setting withLoading to loading state.

onError

open override fun onError(error: Throwable)

rawLaunch

open fun rawLaunch(context: CoroutineContext, start: CoroutineStart, block: suspend CoroutineScope.() -> Unit): Job

Launches a coroutine without any error handling or loading state tracking.

track

open suspend fun track(withLoading: MutableStateFlow<Int>? = loading, onError: suspend (Throwable) -> Unit? = null, block: suspend () -> Unit)

Tracks a suspension block's loading state and errors.

triggerOnInit

@ExperimentalReactiveStateApi

fun CoroutineLauncher.triggerOnInit()

Runs OnInit.trigger for this class.