Action

Action is used to mutate the model and/or trigger effects.

For example:

data object OnDetailsExpandClick : HelpScreenAction {
    override fun HelpScreenModel.proceed() =
        mutate(copy(showDetails = !showDetails))
}

Or using SAM:

val OnDetailExpandClick: HelpScreenAction
    get() = { next(copy(showDetails = !showDetails)) }

TModel

the type of the Loop model

TDependency

the type of the Loop's dependency

Types

data class Next<TModel : Any, TDependency>(val model: TModel? = null, val effects: Set<Effect<TModel, TDependency>> = emptySet())

Represent the result of an Action.

Shorthand for returning an action result without any changes or effects triggered.

Shorthand for returning an action result with optional model changes only.

Shorthand for returning an action result with both changes to the model and triggered effects.

Execute this Action.

Shorthand for returning an action result with triggered effects only.