oskit-kmp/com.outsidesource.oskitkmp.interactor/Interactor

Interactor

abstract class Interactor<T : Any>(initialState: T, dependencies: List<IInteractor<*>> = emptyList()) : IInteractor<T>

Interactor An isolated slice of safely mutable, observable state that encapsulates business logic pertaining to state manipulation.

Observing State When an observer subscribes to state via the flow method it will immediately receive the latest state as the first emit. Afterward, only changes to the state will be emitted to observers.

Updating State The only way to update an Interactor's state is by calling the update method. Calling update will synchronously update the internal state with a new copy of state and notify all observers of the change as long as the new state is different from the previous state.

initialState The initial state of an Interactor.

dependencies A list of Interactors this Interactor is dependent on. When any dependent Interactor is updated, the computed function is called and the resulting state is emitted to all subscribers of this Interactor.

Constructors

Interactor

constructor(initialState: T, dependencies: List<IInteractor<*>> = emptyList())

Properties

state

open override val state: T

Retrieves the current state of the Interactor.

Functions

flow

open override fun flow(): Flow<T>

Returns the state as a flow for observing updates. The latest state will be immediately emitted to a new subscriber.