From 63f1accfaacf82d388bd93745917ee3036679c0c Mon Sep 17 00:00:00 2001 From: Chris Date: Fri, 14 Apr 2023 11:46:20 -0500 Subject: [PATCH] Generated updated documentation --- .../cycle-core/com.chrynan.cycle/-platform-view-model/index.md | 2 +- docs/cycle-core/cycle-core/com.chrynan.cycle/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/cycle-core/cycle-core/com.chrynan.cycle/-platform-view-model/index.md b/docs/cycle-core/cycle-core/com.chrynan.cycle/-platform-view-model/index.md index 0949875..7a48b85 100644 --- a/docs/cycle-core/cycle-core/com.chrynan.cycle/-platform-view-model/index.md +++ b/docs/cycle-core/cycle-core/com.chrynan.cycle/-platform-view-model/index.md @@ -2,7 +2,7 @@ # PlatformViewModel -expect abstract class [PlatformViewModel](index.md)actual abstract class [PlatformViewModel](index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html)actual abstract class [PlatformViewModel](index.md)actual abstract class [PlatformViewModel](index.md) +expect abstract class [PlatformViewModel](index.md)actual abstract class [PlatformViewModel](index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html)actual abstract class [PlatformViewModel](index.md)actual abstract class [PlatformViewModel](index.md)actual abstract class [PlatformViewModel](index.md) The base class that a [ViewModel](../-view-model/index.md) inherits from. This allows each supported platform to have a platform-specific base ViewModel component implementation. For instance, on Android this class can extend from the `androidx.lifecycle.ViewModel` component so that it can be used with the Android lifecycle. diff --git a/docs/cycle-core/cycle-core/com.chrynan.cycle/index.md b/docs/cycle-core/cycle-core/com.chrynan.cycle/index.md index fb851ae..8be20c4 100644 --- a/docs/cycle-core/cycle-core/com.chrynan.cycle/index.md +++ b/docs/cycle-core/cycle-core/com.chrynan.cycle/index.md @@ -15,7 +15,7 @@ | [IntentViewModel](-intent-view-model/index.md) | [common]
@FlowPreview
@ExperimentalCoroutinesApi
abstract class [IntentViewModel](-intent-view-model/index.md)<[Intent](-intent-view-model/index.md), [State](-intent-view-model/index.md), [Change](-intent-view-model/index.md)>(stateStore: [MutableStateStore](-mutable-state-store/index.md)<[State](-intent-view-model/index.md), [Change](-intent-view-model/index.md)>, dispatchers: CoroutineDispatchers = com.chrynan.dispatchers.dispatchers, resetOnUnbind: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false, flatMapStrategy: [FlatMapStrategy](-flat-map-strategy/index.md) = FlatMapStrategy.Latest) : [ViewModel](-view-model/index.md)<[State](-intent-view-model/index.md), [Change](-intent-view-model/index.md)>
An abstract implementation of a [ViewModel](-view-model/index.md) that supports the MVI (Model-View-Intent) design pattern. Inheritors of this class must implement the [performIntentAction](../../../cycle-core/com.chrynan.cycle/-intent-view-model/perform-intent-action.md) function which associates an [Action](index.md#-1083546810%2FClasslikes%2F1627176608) with an [Intent](-intent-view-model/index.md). To emit an [Intent](-intent-view-model/index.md) on an [IntentViewModel](-intent-view-model/index.md), use the [IntentViewModel.intent](-intent-view-model/intent.md) function. | | [MutableStackStateStore](-mutable-stack-state-store/index.md) | [common]
interface [MutableStackStateStore](-mutable-stack-state-store/index.md)<[State](-mutable-stack-state-store/index.md), [Change](-mutable-stack-state-store/index.md)> : [MutableStateStore](-mutable-state-store/index.md)<[State](-mutable-stack-state-store/index.md), [Change](-mutable-stack-state-store/index.md)>
A [MutableStateStore](-mutable-state-store/index.md) that has basic Stack data structure functions that allow going back to previous [State](-mutable-stack-state-store/index.md)s. | | [MutableStateStore](-mutable-state-store/index.md) | [common]
interface [MutableStateStore](-mutable-state-store/index.md)<[State](-mutable-state-store/index.md), [Change](-mutable-state-store/index.md)> : [StateStore](-state-store/index.md)<[State](-mutable-state-store/index.md), [Change](-mutable-state-store/index.md)>
A mutable [StateStore](-state-store/index.md) where the state can be altered by dispatching changes via the [dispatch](-mutable-state-store/dispatch.md) function. | -| [PlatformViewModel](-platform-view-model/index.md) | [common]
expect abstract class [PlatformViewModel](-platform-view-model/index.md)
The base class that a [ViewModel](-view-model/index.md) inherits from. This allows each supported platform to have a platform-specific base ViewModel component implementation. For instance, on Android this class can extend from the `androidx.lifecycle.ViewModel` component so that it can be used with the Android lifecycle.
[android, js, jvm]
[android]
actual abstract class [PlatformViewModel](-platform-view-model/index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html)
[js, jvm]
actual abstract class [PlatformViewModel](-platform-view-model/index.md) | +| [PlatformViewModel](-platform-view-model/index.md) | [common]
expect abstract class [PlatformViewModel](-platform-view-model/index.md)
The base class that a [ViewModel](-view-model/index.md) inherits from. This allows each supported platform to have a platform-specific base ViewModel component implementation. For instance, on Android this class can extend from the `androidx.lifecycle.ViewModel` component so that it can be used with the Android lifecycle.
[android, ios, js, jvm]
[android]
actual abstract class [PlatformViewModel](-platform-view-model/index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html)
[ios, js, jvm]
actual abstract class [PlatformViewModel](-platform-view-model/index.md) | | [PresentationFragment](-presentation-fragment/index.md) | [android]
@FlowPreview
@ExperimentalCoroutinesApi
abstract class [PresentationFragment](-presentation-fragment/index.md)<[State](-presentation-fragment/index.md), [Change](-presentation-fragment/index.md)> : [Fragment](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment.html), [View](../../../cycle-core/cycle-core/com.chrynan.cycle/-view/index.md)<[State](-presentation-fragment/index.md), [Change](-presentation-fragment/index.md)>
An Android [Fragment](https://developer.android.com/reference/kotlin/androidx/fragment/app/Fragment.html) base implementation of a [View](../../../cycle-core/cycle-core/com.chrynan.cycle/-view/index.md) for use with this library's design pattern. | | [Reducer](index.md#-209270086%2FClasslikes%2F1627176608) | [common]
typealias [Reducer](index.md#-209270086%2FClasslikes%2F1627176608)<[State](index.md#-209270086%2FClasslikes%2F1627176608), [Change](index.md#-209270086%2FClasslikes%2F1627176608)> = suspend [State](index.md#-209270086%2FClasslikes%2F1627176608)?.([Change](index.md#-209270086%2FClasslikes%2F1627176608)) -> [State](index.md#-209270086%2FClasslikes%2F1627176608)?
A [Reducer](index.md#-209270086%2FClasslikes%2F1627176608) is responsible for determining the State that is displayed in the UI. A [Reducer](index.md#-209270086%2FClasslikes%2F1627176608) is a function that takes the current State and a Change and derives a new State. | | [StateStore](-state-store/index.md) | [common]
interface [StateStore](-state-store/index.md)<[State](-state-store/index.md), [Change](-state-store/index.md)>
A component that holds the whole state tree for a [ViewModel](-view-model/index.md). The only way to change the state inside it is to dispatch a [Change](-state-store/index.md) to it. |