Package org.orbitmvi.orbit

Types

OrbitVerification

common

class OrbitVerification<STATE : Any, SIDE_EFFECT : Any>

RegularTestContainerHost

common

class RegularTestContainerHost<STATE : Any, SIDE_EFFECT : Any, T : ContainerHost<STATE, SIDE_EFFECT>>(actual: T, initialState: STATE, runOnCreate: Boolean) : TestContainerHost<STATE, SIDE_EFFECT, T>

SuspendingTestContainerHost

common

class SuspendingTestContainerHost<STATE : Any, SIDE_EFFECT : Any, T : ContainerHost<STATE, SIDE_EFFECT>>(actual: T, initialState: STATE, isolateFlow: Boolean, runOnCreate: Boolean) : TestContainerHost<STATE, SIDE_EFFECT, T>

TestContainerHost

common

sealed class TestContainerHost<STATE : Any, SIDE_EFFECT : Any, T : ContainerHost<STATE, SIDE_EFFECT>>

TestFlowObserver

common

class TestFlowObserver<T>(flow: Flow<T>)

Allows you to record all observed values of a flow for easy testing.

Functions

liveTest

common

fun <STATE : Any, SIDE_EFFECT : Any, T : ContainerHost<STATE, SIDE_EFFECT>> T.liveTest(initialState: STATE, runOnCreate: Boolean = false, settings: Container.Settings = container.settings.copy(intentDispatcher = Dispatchers.Unconfined)): RegularTestContainerHost<STATE, SIDE_EFFECT, T>

Puts your ContainerHost into live test mode.

test

common

fun <T> Flow<T>.test(): TestFlowObserver<T>

Allows you to put a Flow into test mode.

fun <STATE : Any, SIDE_EFFECT : Any, T : ContainerHost<STATE, SIDE_EFFECT>> T.test(initialState: STATE, isolateFlow: Boolean = true, runOnCreate: Boolean = false, settings: Container.Settings = container.settings): SuspendingTestContainerHost<STATE, SIDE_EFFECT, T>

Puts your ContainerHost into suspending test mode.