test/pro.respawn.flowmvi.test.plugin/PluginTestScope

PluginTestScope

interface PluginTestScope<S : MVIState, I : MVIIntent, A : MVIAction> : PipelineContext<S, I, A> , ShutdownContext<S, I, A> , StorePlugin<S, I, A>

Properties

config

abstract val config: StoreConfiguration<S>

coroutineContext

abstract val coroutineContext: CoroutineContext

isActive

abstract val isActive: Boolean

isStarted

abstract val isStarted: Boolean

key

open override val key: CoroutineContext.Key<*>

name

abstract val name: String?

states

abstract override val states: StateFlow<S>

subscriberCount

abstract val subscriberCount: StateFlow<Int>

timeTravel

abstract val timeTravel: TimeTravel<S, I, A>

Functions

action

abstract suspend fun action(action: A)

awaitStartup

abstract suspend fun awaitStartup()

awaitUntilClosed

abstract suspend fun awaitUntilClosed()

expect abstract fun close()

closeAndWait

abstract suspend fun closeAndWait()

compareAndSet

abstract fun compareAndSet(old: S, new: S): Boolean

consume

open suspend fun <T> Flow<T>.consume(context: CoroutineContext)

emit

abstract suspend fun emit(intent: I)

ensureStarted

fun StoreLifecycle.ensureStarted()

fold

open override fun <R> fold(initial: R, operation: (R, CoroutineContext.Element) -> R): R

get

open operator override fun <E : CoroutineContext.Element> get(key: CoroutineContext.Key<E>): E?

intent

abstract fun intent(intent: I)

invoke

open operator override fun invoke(config: StoreConfiguration<S>): StorePlugin<S, I, A>

minusKey

open override fun minusKey(key: CoroutineContext.Key<*>): CoroutineContext

onAction

open suspend fun PipelineContext<S, I, A>.onAction(action: A): A?

onActionDispatch

open fun onActionDispatch(action: A): A?

onException

open suspend fun PipelineContext<S, I, A>.onException(e: Exception): Exception?

onIntent

open suspend fun PipelineContext<S, I, A>.onIntent(intent: I): I?

onIntentEnqueue

open fun onIntentEnqueue(intent: I): I?

onStart

open suspend fun PipelineContext<S, I, A>.onStart()

onState

open suspend fun PipelineContext<S, I, A>.onState(old: S, new: S): S?

onStop

open fun ShutdownContext<S, I, A>.onStop(e: Exception?)

onSubscribe

open suspend fun PipelineContext<S, I, A>.onSubscribe(newSubscriberCount: Int)

onUndeliveredAction

open fun ShutdownContext<S, I, A>.onUndeliveredAction(action: A)

onUndeliveredIntent

open fun ShutdownContext<S, I, A>.onUndeliveredIntent(intent: I)

onUnsubscribe

open suspend fun PipelineContext<S, I, A>.onUnsubscribe(newSubscriberCount: Int)

plus

open operator fun plus(context: CoroutineContext): CoroutineContext

send

abstract fun send(action: A)

test

suspend fun <S : MVIState, I : MVIIntent, A : MVIAction> LazyPlugin<S, I, A>.test(initial: S, timeTravel: TimeTravel<S, I, A> = TimeTravel(), configuration: StoreConfigurationBuilder.() -> Unit = { debuggable = true }, block: suspend PluginTestScope<S, I, A>.() -> Unit)

A function that runs a test on a StorePlugin.

updateState

abstract suspend fun updateState(transform: suspend S.() -> S)

withState

abstract suspend fun withState(block: suspend S.() -> Unit)