3.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`

Types

fun interface Action<TModel : Any, TDependency>

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

fun interface ActionEmitter<TModel : Any, TDependency>

Interface for Action emitters.

AnyActionEmitter

typealias AnyActionEmitter = ActionEmitter<*, *>

Type that represents any ActionEmitter.

typealias AnyLoop = Loop<*, *, *, *, *>

fun interface ArgsApplyer<TModel : Any, in TArgs>

Applies arguments to a model.

fun interface Effect<TModel : Any, TDependency>

Effect is used to perform background tasks.

HasActionEmitter

interface HasActionEmitter

Can be used to attach child emitters when implemented by a Loop dependency.

abstract class Loop<out TState : Any, TModel : Any, in TArgs, TDependency, in TAction : Action<TModel, TDependency>>(model: TModel, renderer: Renderer<TState, TModel>, args: TArgs? = null, argsApplyer: ArgsApplyer<TModel, TArgs>? = null, onStart: ActionEmitter<TModel, TDependency>.() -> Unit = {}, dependency: TDependency? = null, effectContext: CoroutineContext = Dispatchers.IO) : ActionEmitter<TModel, TDependency>

Base class that handles unidirectional data flow.

fun interface LoopBuilder<out TState : Any, 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<out TState, in TModel : Any>

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

Properties

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 <TState : Any, TModel : Any, TArgs, TDependency, TAction : Action<TModel, TDependency>, TLoopBuilder : LoopBuilder<TState, TModel, TArgs, TDependency, TAction>> Loop<TState, TModel, TArgs, TDependency, TAction>.asBuilder(): TLoopBuilder

fun <TModel : Any, TDependency> Action<TModel, TDependency>.next(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.

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.