From 7bbaf9e464d9124cb96e46b4862ea5a521e9c8d9 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" Date: Thu, 21 Nov 2024 03:02:07 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20hoc08109?= =?UTF-8?q?8/solivagant@ae35a6174fa548ba46ab5d6a1e86a1f3236a6070=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../collect-as-state-with-lifecycle.html | 2 +- .../current-state-as-state.html | 2 +- .../index.html | 2 +- .../-lenient-lifecycle-registry/index.html | 2 +- .../-lifecycle-registry/index.html | 2 +- .../-lifecycle/index.html | 2 +- docs/latest/sitemap.xml | 6 +++--- docs/latest/sitemap.xml.gz | Bin 230 -> 230 bytes 8 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle.compose/collect-as-state-with-lifecycle.html b/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle.compose/collect-as-state-with-lifecycle.html index d3883ff8..18f85acd 100644 --- a/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle.compose/collect-as-state-with-lifecycle.html +++ b/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle.compose/collect-as-state-with-lifecycle.html @@ -63,7 +63,7 @@

collectAsStateWithLifecycle

-
@Composable
fun <T> StateFlow<T>.collectAsStateWithLifecycle(lifecycleOwner: LifecycleOwner = LocalLifecycleOwner.current, minActiveState: Lifecycle.State = Lifecycle.State.STARTED, context: CoroutineContext = EmptyCoroutineContext): State<T>(source)

Collects values from this StateFlow and represents its latest value via State in a lifecycle-aware manner.

The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage whenever the lifecycleOwner's lifecycle is at least minActiveState.

This StateFlow is collected every time the lifecycleOwner's lifecycle reaches the minActiveState Lifecycle state. The collection stops when the lifecycleOwner's lifecycle falls below minActiveState.

Warning: Lifecycle.State.INITIALIZED is not allowed in this API. Passing it as a parameter will throw an IllegalArgumentException.

Parameters

lifecycleOwner

LifecycleOwner whose lifecycle is used to restart collecting this flow.

minActiveState

Lifecycle.State in which the upstream flow gets collected. The collection will stop if the lifecycle falls below that state, and will restart if it's in that state again.

context

CoroutineContext to use for collecting.

@Composable
fun <T> StateFlow<T>.collectAsStateWithLifecycle(lifecycle: Lifecycle, minActiveState: Lifecycle.State = Lifecycle.State.STARTED, context: CoroutineContext = EmptyCoroutineContext): State<T>(source)

Collects values from this StateFlow and represents its latest value via State in a lifecycle-aware manner.

The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage whenever the lifecycle is at least minActiveState.

This StateFlow is collected every time lifecycle reaches the minActiveState Lifecycle state. The collection stops when lifecycle falls below minActiveState.

Warning: Lifecycle.State.INITIALIZED is not allowed in this API. Passing it as a parameter will throw an IllegalArgumentException.

Parameters

lifecycle

Lifecycle used to restart collecting this flow.

minActiveState

Lifecycle.State in which the upstream flow gets collected. The collection will stop if the lifecycle falls below that state, and will restart if it's in that state again.

context

CoroutineContext to use for collecting.

@Composable
fun <T> Flow<T>.collectAsStateWithLifecycle(initialValue: T, lifecycleOwner: LifecycleOwner = LocalLifecycleOwner.current, minActiveState: Lifecycle.State = Lifecycle.State.STARTED, context: CoroutineContext = EmptyCoroutineContext): State<T>(source)

Collects values from this Flow and represents its latest value via State in a lifecycle-aware manner.

Every time there would be new value posted into the Flow the returned State will be updated causing recomposition of every State.value usage whenever the lifecycleOwner's lifecycle is at least minActiveState.

This Flow is collected every time the lifecycleOwner's lifecycle reaches the minActiveState Lifecycle state. The collection stops when the lifecycleOwner's lifecycle falls below minActiveState.

Warning: Lifecycle.State.INITIALIZED is not allowed in this API. Passing it as a parameter will throw an IllegalArgumentException.

Parameters

initialValue

The initial value given to the returned State.value.

lifecycleOwner

LifecycleOwner whose lifecycle is used to restart collecting this flow.

minActiveState

Lifecycle.State in which the upstream flow gets collected. The collection will stop if the lifecycle falls below that state, and will restart if it's in that state again.

context

CoroutineContext to use for collecting.

@Composable
fun <T> Flow<T>.collectAsStateWithLifecycle(initialValue: T, lifecycle: Lifecycle, minActiveState: Lifecycle.State = Lifecycle.State.STARTED, context: CoroutineContext = EmptyCoroutineContext): State<T>(source)

Collects values from this Flow and represents its latest value via State in a lifecycle-aware manner.

Every time there would be new value posted into the Flow the returned State will be updated causing recomposition of every State.value usage whenever the lifecycle is at least minActiveState.

This Flow is collected every time lifecycle reaches the minActiveState Lifecycle state. The collection stops when lifecycle falls below minActiveState.

Warning: Lifecycle.State.INITIALIZED is not allowed in this API. Passing it as a parameter will throw an IllegalArgumentException.

Parameters

initialValue

The initial value given to the returned State.value.

lifecycle

Lifecycle used to restart collecting this flow.

minActiveState

Lifecycle.State in which the upstream flow gets collected. The collection will stop if the lifecycle falls below that state, and will restart if it's in that state again.

context

CoroutineContext to use for collecting.

+
@Composable
fun <T> StateFlow<T>.collectAsStateWithLifecycle(lifecycleOwner: LifecycleOwner = LocalLifecycleOwner.current, minActiveState: Lifecycle.State = Lifecycle.State.STARTED, context: CoroutineContext = EmptyCoroutineContext): State<T>(source)

Collects values from this StateFlow and represents its latest value via State in a lifecycle-aware manner.

The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage whenever the lifecycleOwner's lifecycle is at least minActiveState.

This StateFlow is collected every time the lifecycleOwner's lifecycle reaches the minActiveState Lifecycle state. The collection stops when the lifecycleOwner's lifecycle falls below minActiveState.

Warning: Lifecycle.State.INITIALIZED is not allowed in this API. Passing it as a parameter will throw an IllegalArgumentException.

Parameters

lifecycleOwner

LifecycleOwner whose lifecycle is used to restart collecting this flow.

minActiveState

Lifecycle.State in which the upstream flow gets collected. The collection will stop if the lifecycle falls below that state, and will restart if it's in that state again.

context

CoroutineContext to use for collecting.

@Composable
fun <T> StateFlow<T>.collectAsStateWithLifecycle(lifecycle: Lifecycle, minActiveState: Lifecycle.State = Lifecycle.State.STARTED, context: CoroutineContext = EmptyCoroutineContext): State<T>(source)

Collects values from this StateFlow and represents its latest value via State in a lifecycle-aware manner.

The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage whenever the lifecycle is at least minActiveState.

This StateFlow is collected every time lifecycle reaches the minActiveState Lifecycle state. The collection stops when lifecycle falls below minActiveState.

Warning: Lifecycle.State.INITIALIZED is not allowed in this API. Passing it as a parameter will throw an IllegalArgumentException.

Parameters

lifecycle

Lifecycle used to restart collecting this flow.

minActiveState

Lifecycle.State in which the upstream flow gets collected. The collection will stop if the lifecycle falls below that state, and will restart if it's in that state again.

context

CoroutineContext to use for collecting.

@Composable
fun <T> Flow<T>.collectAsStateWithLifecycle(initialValue: T, lifecycleOwner: LifecycleOwner = LocalLifecycleOwner.current, minActiveState: Lifecycle.State = Lifecycle.State.STARTED, context: CoroutineContext = EmptyCoroutineContext): State<T>(source)

Collects values from this Flow and represents its latest value via State in a lifecycle-aware manner.

Every time there would be new value posted into the Flow the returned State will be updated causing recomposition of every State.value usage whenever the lifecycleOwner's lifecycle is at least minActiveState.

This Flow is collected every time the lifecycleOwner's lifecycle reaches the minActiveState Lifecycle state. The collection stops when the lifecycleOwner's lifecycle falls below minActiveState.

Warning: Lifecycle.State.INITIALIZED is not allowed in this API. Passing it as a parameter will throw an IllegalArgumentException.

Parameters

initialValue

The initial value given to the returned State.value.

lifecycleOwner

LifecycleOwner whose lifecycle is used to restart collecting this flow.

minActiveState

Lifecycle.State in which the upstream flow gets collected. The collection will stop if the lifecycle falls below that state, and will restart if it's in that state again.

context

CoroutineContext to use for collecting.

@Composable
fun <T> Flow<T>.collectAsStateWithLifecycle(initialValue: T, lifecycle: Lifecycle, minActiveState: Lifecycle.State = Lifecycle.State.STARTED, context: CoroutineContext = EmptyCoroutineContext): State<T>(source)

Collects values from this Flow and represents its latest value via State in a lifecycle-aware manner.

Every time there would be new value posted into the Flow the returned State will be updated causing recomposition of every State.value usage whenever the lifecycle is at least minActiveState.

This Flow is collected every time lifecycle reaches the minActiveState Lifecycle state. The collection stops when lifecycle falls below minActiveState.

Warning: Lifecycle.State.INITIALIZED is not allowed in this API. Passing it as a parameter will throw an IllegalArgumentException.

Parameters

initialValue

The initial value given to the returned State.value.

lifecycle

Lifecycle used to restart collecting this flow.

minActiveState

Lifecycle.State in which the upstream flow gets collected. The collection will stop if the lifecycle falls below that state, and will restart if it's in that state again.

context

CoroutineContext to use for collecting.

© 2024 CopyrightGenerated by dokka diff --git a/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle.compose/current-state-as-state.html b/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle.compose/current-state-as-state.html index aa55ecae..21a24c3c 100644 --- a/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle.compose/current-state-as-state.html +++ b/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle.compose/current-state-as-state.html @@ -63,7 +63,7 @@

currentStateAsState

-
@Composable
fun Lifecycle.currentStateAsState(): State<Lifecycle.State>(source)

Collects values from the Lifecycle.currentStateFlow and represents its latest value via State. The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage.

+
@Composable
fun Lifecycle.currentStateAsState(): State<Lifecycle.State>(source)

Collects values from the Lifecycle.currentStateFlow and represents its latest value via State. The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage.

© 2024 CopyrightGenerated by dokka diff --git a/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle.compose/index.html b/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle.compose/index.html index 74200ed5..df711fad 100644 --- a/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle.compose/index.html +++ b/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle.compose/index.html @@ -157,7 +157,7 @@

Functions

-
@Composable
fun Lifecycle.currentStateAsState(): State<Lifecycle.State>

Collects values from the Lifecycle.currentStateFlow and represents its latest value via State. The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage.

+
@Composable
fun Lifecycle.currentStateAsState(): State<Lifecycle.State>

Collects values from the Lifecycle.currentStateFlow and represents its latest value via State. The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage.

diff --git a/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle/-lenient-lifecycle-registry/index.html b/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle/-lenient-lifecycle-registry/index.html index 67dba8bd..0a81f4f0 100644 --- a/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle/-lenient-lifecycle-registry/index.html +++ b/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle/-lenient-lifecycle-registry/index.html @@ -128,7 +128,7 @@

Functions

-
@Composable
fun Lifecycle.currentStateAsState(): State<Lifecycle.State>

Collects values from the Lifecycle.currentStateFlow and represents its latest value via State. The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage.

+
@Composable
fun Lifecycle.currentStateAsState(): State<Lifecycle.State>

Collects values from the Lifecycle.currentStateFlow and represents its latest value via State. The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage.

diff --git a/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle/-lifecycle-registry/index.html b/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle/-lifecycle-registry/index.html index 123ca3e6..cb2775c0 100644 --- a/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle/-lifecycle-registry/index.html +++ b/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle/-lifecycle-registry/index.html @@ -128,7 +128,7 @@

Functions

-
@Composable
fun Lifecycle.currentStateAsState(): State<Lifecycle.State>

Collects values from the Lifecycle.currentStateFlow and represents its latest value via State. The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage.

+
@Composable
fun Lifecycle.currentStateAsState(): State<Lifecycle.State>

Collects values from the Lifecycle.currentStateFlow and represents its latest value via State. The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage.

diff --git a/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle/-lifecycle/index.html b/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle/-lifecycle/index.html index def6a89d..dce68a6c 100644 --- a/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle/-lifecycle/index.html +++ b/docs/latest/API/lifecycle/com.hoc081098.solivagant.lifecycle/-lifecycle/index.html @@ -192,7 +192,7 @@

Functions

-
@Composable
fun Lifecycle.currentStateAsState(): State<Lifecycle.State>

Collects values from the Lifecycle.currentStateFlow and represents its latest value via State. The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage.

+
@Composable
fun Lifecycle.currentStateAsState(): State<Lifecycle.State>

Collects values from the Lifecycle.currentStateFlow and represents its latest value via State. The StateFlow.value is used as an initial value. Every time there would be new value posted into the StateFlow the returned State will be updated causing recomposition of every State.value usage.

diff --git a/docs/latest/sitemap.xml b/docs/latest/sitemap.xml index 1ae6920f..de03b126 100644 --- a/docs/latest/sitemap.xml +++ b/docs/latest/sitemap.xml @@ -2,14 +2,14 @@ https://hoc081098.github.io/solivagant/docs/0.x/ - 2024-11-20 + 2024-11-21 https://hoc081098.github.io/solivagant/docs/0.x/changelog/ - 2024-11-20 + 2024-11-21 https://hoc081098.github.io/solivagant/docs/0.x/multiplatform/ - 2024-11-20 + 2024-11-21 \ No newline at end of file diff --git a/docs/latest/sitemap.xml.gz b/docs/latest/sitemap.xml.gz index 6e39bc10148942a38c48c6150c72c26cda64b6c1..7f8f1330210753dc3a0c092af16b40e770666505 100644 GIT binary patch literal 230 zcmVp0U2K#g4YlPKQVP^YV3e#^@t&&Q9Fey#-kCv z6sMlMQ2hGI0|H?TSM78zFrlGJy1@YZ)lZ0~l5kR;=#H(FZ71u>YxY!yZ`r>vV7$)G gMs)vgC9Sc9IqLF-OZvT?N2-ricN3N400;sA00nYsO8@`> literal 230 zcmV0euh4-AI%D!=0u_&kwJ5Dfj zfJ_>aNJ(7PDdqU2fJU<(A>oaGWPk5T?oYQEs;imFV;We)1*=TbIQnD<_WgCPJ9d)0 zewhQAT$SZS19Le~M}T!*Ir(g&nuz0UfwU_P!D|SDADG-#B{smbdPE;k%Z)+><4}vP z5r>XjpWX7qJpy6yS7lYoFrubHxJ3T4Ay$AvT0AjjoG5`Po