reaktiv-core/io.github.syrou.reaktiv.core

Package-level declarations

Types

CrashListener

interface CrashListener

Listener for crashes that occur during logic execution in the Store.

CrashRecovery

enum CrashRecovery : Enum<CrashRecovery>

Determines how the Store should handle a crash after listeners are notified.

Dispatch

typealias Dispatch = (ModuleAction) -> Unit

DispatchResult

sealed class DispatchResult

Result of a dispatch operation, indicating whether the action was processed.

DispatchSuspend

typealias DispatchSuspend = suspend (ModuleAction) -> Unit

ExperimentalReaktivApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class ExperimentalReaktivApi

HighPriorityAction

interface HighPriorityAction

Marker interface for high-priority actions.

InternalStoreOperations

interface InternalStoreOperations

Internal operations for specialized use cases like DevTools and testing.

Logic

interface Logic

Middleware

typealias Middleware = suspend (action: ModuleAction, getAllStates: suspend () -> Map<String, ModuleState>, storeAccessor: StoreAccessor, updatedState: suspend (ModuleAction) -> ModuleState) -> Unit

Type alias for middleware functions.

Module

interface Module<S : ModuleState, A : ModuleAction>

Interface for defining modules in the MVLI architecture.

ModuleAction

@Serializable

abstract class ModuleAction(moduleTag: KClass<*> = KClass::class)

Base class for module actions.

ModuleLogic

open class ModuleLogic : Logic

Base class for module logic implementations.

ModuleState

interface ModuleState

Marker interface for module state classes.

ModuleWithLogic

interface ModuleWithLogic<S : ModuleState, A : ModuleAction, L : ModuleLogic> : Module<S, A>

The recommended interface for defining modules with type-safe logic access.

StateSelector

@ObjCName(name = "StateSelector")

open class StateSelector<S : ModuleState>

Generic state selector for Swift/iOS. Wraps KClass internally so Swift doesn't need to deal with it.

Store

class Store : StoreAccessor, InternalStoreOperations

StoreAccessor

abstract class StoreAccessor(scope: CoroutineScope) : CoroutineScope

Provides access to dispatch, state selection, and logic selection.

StoreDSL

class StoreDSL

Functions

createStore

fun createStore(block: StoreDSL.() -> Unit): Store

Creates a new Store instance using the DSL builder.