commonMain.pro.respawn.flowmvi.api.ActionProvider.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core-jvm Show documentation

A Kotlin Multiplatform MVI library based on plugins that is simple, fast, powerful & flexible

There is a newer version: 3.0.0

package pro.respawn.flowmvi.api

import kotlinx.coroutines.flow.Flow

/**
 * An entity that can provide [MVIAction]s through the [actions] flow.
 * This flow may behave differently depending on [ActionShareBehavior] chosen.
 * This is mainly implemented by the [Store] and exposed through [Provdier] ([Store.subscribe])
 */
public interface ActionProvider {

    /**
     * A flow of [MVIAction]s to be handled by the [MVISubscriber],
     * usually resulting in one-shot events.
     * How actions are distributed depends on [ActionShareBehavior].
     */
    public val actions: Flow
}