2.0.0

hurok-base/com.ekezet.hurok

Package-level declarations

A multiplatform UDF-based application framework

Parts

Name	Description
Model	Holds data for business logic
ViewState	UI state derived from the `Model`
Renderer	Uses the `Model` to create new `State` for the UI
Action	Mutates the `Model` and can trigger (any) `Effect`
Effect	Does background work and triggers (any) `Action`
Loop	Handles `Action` and `Effect`

A multiplatform UDF-based application framework

Parts

Name	Description
Model	Holds data for business logic
ViewState	UI state derived from the `Model`
Renderer	Uses the `Model` to create new `State` for the UI
Action	Mutates the `Model` and can trigger (any) `Effect`
Effect	Does background work and triggers (any) `Action`
Loop	Handles `Action` and `Effect`

A multiplatform UDF-based application framework

Parts

Name	Description
Model	Holds data for business logic
ViewState	UI state derived from the `Model`
Renderer	Uses the `Model` to create new `State` for the UI
Action	Mutates the `Model` and can trigger (any) `Effect`
Effect	Does background work and triggers (any) `Action`
Loop	Handles `Action` and `Effect`

Types

fun interface Action<TModel : Any, TDependency>

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

interface ActionEmitter<TModel : Any, TDependency>

Interface for Action emitters.

AnyActionEmitter

typealias AnyActionEmitter = ActionEmitter<*, *>

Type that represents any ActionEmitter.

DispatcherProvider

actual object DispatcherProvider

expect object DispatcherProvider

Multiplatform coroutine dispatcher provider.

actual object DispatcherProvider

fun interface Effect<TModel : Any, TDependency>

Effect is used to perform background tasks.

abstract class Loop<out TState : ViewState<TModel, TDependency>, TModel : Any, in TArgs, TDependency, in TAction : Action<TModel, TDependency>>(model: TModel, renderer: Renderer<TModel, TState>, args: TArgs? = null, firstAction: TAction? = null, dependency: TDependency? = null, effectContext: CoroutineContext = DispatcherProvider.IO) : ActionEmitter<TModel, TDependency>

Base class that handles unidirectional data flow.

fun interface LoopBuilder<out TState : ViewState<TModel, TDependency>, TModel : Any, in TArgs, TDependency, in TAction : Action<TModel, TDependency>>

Interface for building a given Loop.

typealias next<TModel, TDependency> = Action.Next<TModel, TDependency>

fun interface Renderer<in TModel : Any, out TState : ViewState<*, *>>

Interface for transforming the current Loop model into a new view state.

abstract class ViewState<TModel : Any, TDependency>

Used to delegate the emitter to the rendered state for starting actions.

Properties

val <TState : ViewState<TModel, TDependency>, TModel : Any, TArgs, TDependency, TAction : Action<TModel, TDependency>> Loop<TState, TModel, TArgs, TDependency, TAction>.firstState: TState

The first state of this Loop in a blocking fashion. Useful for testing.

val <TModel : Any, TDependency> Action<TModel, TDependency>.skip: Action.Next<TModel, TDependency>

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

Functions

fun <TModel : Any, TDependency> Action<TModel, TDependency>.mutate(model: TModel? = null): Action.Next<TModel, TDependency>

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

fun <TModel : Any, TDependency> Action<TModel, TDependency>.outcome(model: TModel? = null, vararg effects: Effect<TModel, TDependency>): Action.Next<TModel, TDependency>

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

inline fun <TState : ViewState<TModel, TDependency>, TModel : Any, TArgs, TDependency, TAction : Action<TModel, TDependency>, TRenderer : Renderer<TModel, TState>, TLoop : Loop<TState, TModel, TArgs, TDependency, TAction>> renderState(constructor: (model: TModel, renderer: TRenderer, args: TArgs?) -> TLoop, model: TModel, renderer: TRenderer, args: TArgs? = null): TState

Render a given Loop into a state.

fun <TModel : Any, TDependency> Action<TModel, TDependency>.trigger(vararg effects: Effect<TModel, TDependency>): Action.Next<TModel, TDependency>

Shorthand for returning an action result with triggered effects only.