core/com.helloanwar.mvvmate.core/BaseViewModel

BaseViewModel

abstract class BaseViewModel<S : UiState, A : UiAction>(initialState: S) : ViewModel(source)

Base class for ViewModels that manages UI state and handles user actions.

This class holds the common logic for state management using StateFlow and provides a mechanism to handle actions asynchronously using Kotlin coroutines.

Parameters

The type of UI state that this ViewModel manages. It should implement UiState.

The type of user actions (intents) that this ViewModel responds to. It should implement UiAction.

Inheritors

BaseViewModelWithEffect

Constructors

BaseViewModel

constructor(initialState: S)

Properties

state

val state: StateFlow<S>

Functions

addCloseable

expect open fun addCloseable(closeable: AutoCloseable)

expect fun addCloseable(key: String, closeable: AutoCloseable)

getCloseable

expect fun <T : AutoCloseable> getCloseable(key: String): T?

handleAction

fun handleAction(action: A)

Handles a user action and updates the state accordingly using the provided onAction method.

onAction

abstract suspend fun onAction(action: A)

Abstract method to be implemented by subclasses to handle the specific action logic.