orbit-core/org.orbitmvi.orbit.syntax.simple

Package-level declarations

Types

Link copied to clipboard
data class SimpleContext<STATE : Any>(val state: STATE)

Represents the current context in which a simple orbit is executing.

Link copied to clipboard
class SimpleSyntax<S : Any, SE : Any>(val containerContext: ContainerContext<S, SE>)

Functions

Link copied to clipboard
fun <STATE : Any, SIDE_EFFECT : Any> ContainerHost<STATE, SIDE_EFFECT>.blockingIntent(registerIdling: Boolean = true, transformer: suspend SimpleSyntax<STATE, SIDE_EFFECT>.() -> Unit)

Build and execute an intent on Container in a blocking manner, without dispatching.

Link copied to clipboard
fun <STATE : Any, SIDE_EFFECT : Any> ContainerHost<STATE, SIDE_EFFECT>.intent(registerIdling: Boolean = true, transformer: suspend SimpleSyntax<STATE, SIDE_EFFECT>.() -> Unit): Job

Build and execute an intent on Container.

Link copied to clipboard
suspend fun <S : Any, SE : Any> SimpleSyntax<S, SE>.postSideEffect(sideEffect: SE)

Side effects allow you to deal with things like tracking, navigation etc.

Link copied to clipboard
suspend fun <S : Any, SE : Any> SimpleSyntax<S, SE>.reduce(reducer: SimpleContext<S>.() -> S)

Reducers reduce the current state and incoming events to produce a new state.

Link copied to clipboard
suspend fun <S : Any, SE : Any> SimpleSyntax<S, SE>.repeatOnSubscription(block: suspend CoroutineScope.() -> Unit)