mirror of
https://github.com/InsanusMokrassar/MicroUtils.git
synced 2024-11-09 01:43:49 +00:00
81 lines
15 KiB
HTML
81 lines
15 KiB
HTML
<!DOCTYPE html>
|
|
<html class="no-js">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>asComposeState</title>
|
|
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
|
|
<script>var pathToRoot = "../../";</script>
|
|
<script>document.documentElement.classList.replace("no-js","js");</script>
|
|
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
|
if (storage == null) {
|
|
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
|
if (osDarkSchemePreferred === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
} else {
|
|
const savedDarkMode = JSON.parse(storage)
|
|
if(savedDarkMode === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
}
|
|
</script>
|
|
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
|
|
<link href="../../styles/style.css" rel="Stylesheet">
|
|
<link href="../../styles/main.css" rel="Stylesheet">
|
|
<link href="../../styles/prism.css" rel="Stylesheet">
|
|
<link href="../../styles/logo-styles.css" rel="Stylesheet">
|
|
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
|
|
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
|
|
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
|
</head>
|
|
<body>
|
|
<div class="root">
|
|
<nav class="navigation" id="navigation-wrapper">
|
|
<div class="navigation--inner">
|
|
<div class="navigation-title">
|
|
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
|
|
<div class="library-name">
|
|
<a class="library-name--link" href="../../index.html">
|
|
micro_utils.dokka
|
|
</a>
|
|
</div>
|
|
<div class="library-version">
|
|
0.20.18 </div>
|
|
</div>
|
|
<div class="filter-section" id="filter-section">
|
|
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/commonMain">common</button>
|
|
</div>
|
|
</div>
|
|
<div class="navigation-controls">
|
|
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
|
|
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
|
|
</div>
|
|
</nav>
|
|
<div id="container">
|
|
<div class="sidebar" id="leftColumn">
|
|
<div class="sidebar--inner" id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div class="main-content" data-page-type="member" id="content" pageIds="micro_utils.dokka::dev.inmo.micro_utils.coroutines.compose//asComposeState/kotlinx.coroutines.flow.Flow[TypeParam(bounds=[kotlin.Any?])]#TypeParam(bounds=[kotlin.Any?])#kotlinx.coroutines.CoroutineScope#kotlin.coroutines.CoroutineContext?#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,TypeParam(bounds=[kotlin.Any?])?]/PointingToDeclaration//-1478683138">
|
|
<div class="breadcrumbs"><a href="../../index.html">micro_utils.dokka</a><span class="delimiter">/</span><a href="index.html">dev.inmo.micro_utils.coroutines.compose</a><span class="delimiter">/</span><span class="current">asComposeState</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>as</span><wbr></wbr><span>Compose</span><wbr></wbr><span><span>State</span></span></h1>
|
|
</div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="as-compose-state.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><span class="token keyword"></span><a href="as-compose-state.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="as-compose-state.html"><span class="token function">asComposeState</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">initial<span class="token operator">: </span><a href="as-compose-state.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">useContextOnChange<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token operator">?</span><span class="token operator"> = </span>Dispatchers.Main<span class="token punctuation">, </span></span><span class="parameter ">onException<span class="token operator">: </span><a href="../dev.inmo.micro_utils.coroutines/-exception-handler/index.html">ExceptionHandler</a><span class="token operator"><</span><span class="token keyword"></span><a href="as-compose-state.html">T</a><span class="token operator">?</span><span class="token operator">></span><span class="token operator"> = </span>defaultSafelyWithoutExceptionHandlerWithNull</span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token operator"><</span><span class="token keyword"></span><a href="as-compose-state.html">T</a><span class="token operator">></span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/compose/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/compose/FlowAsState.kt#L70">source</a>)</span></span></div><p class="paragraph">Will create MutableState using <a href="as-mutable-compose-state.html">asMutableComposeState</a> and use <a href="../dev.inmo.micro_utils.common.compose/as-state.html">asState</a> to convert it as immutable state</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>initial</span></span></u></div></span></div><div><div class="title"><p class="paragraph">First value which will be passed to the result State</p></div></div></div></div><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>scope</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be used to <a href="../dev.inmo.micro_utils.coroutines/subscribe-safely-without-exceptions.html">subscribeSafelyWithoutExceptions</a> on <span data-unresolved-link="dev.inmo.micro_utils.coroutines.compose//&lt;this&gt;/#/PointingToCallableParameters(-1)/">this</span> to update returned State</p></div></div></div></div><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>use</span><wbr></wbr><span>Context</span><wbr></wbr><span>On</span><wbr></wbr><span><span>Change</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be used to change context inside of <a href="../dev.inmo.micro_utils.coroutines/subscribe-safely-without-exceptions.html">subscribeSafelyWithoutExceptions</a> to ensure that change will happen in the required <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a>. <span data-unresolved-link="kotlinx.coroutines/Dispatchers/Main/#/PointingToDeclaration/">Dispatchers.Main</span> by default</p></div></div></div></div><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr></wbr><span><span>Exception</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be passed to the <a href="../dev.inmo.micro_utils.coroutines/subscribe-safely-without-exceptions.html">subscribeSafelyWithoutExceptions</a> as uncaught exceptions handler</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="as-compose-state.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span><span class="token operator"><</span><span class="token keyword"></span><a href="as-compose-state.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="as-compose-state.html"><span class="token function">asComposeState</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">useContextOnChange<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token operator">?</span><span class="token operator"> = </span>Dispatchers.Main<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>onException<span class="token operator">: </span><a href="../dev.inmo.micro_utils.coroutines/-exception-handler/index.html">ExceptionHandler</a><span class="token operator"><</span><span class="token keyword"></span><a href="as-compose-state.html">T</a><span class="token operator">?</span><span class="token operator">></span><span class="token operator"> = </span>defaultSafelyWithoutExceptionHandlerWithNull</span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token operator"><</span><span class="token keyword"></span><a href="as-compose-state.html">T</a><span class="token operator">></span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/compose/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/compose/FlowAsState.kt#L89">source</a>)</span></span></div><p class="paragraph">Will map <span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">this</span> as State. This conversation will pass its <span data-unresolved-link="kotlinx.coroutines.flow/StateFlow/value/#/PointingToDeclaration/">StateFlow.value</span> as the first value</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>scope</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be used to <a href="../dev.inmo.micro_utils.coroutines/subscribe-safely-without-exceptions.html">subscribeSafelyWithoutExceptions</a> on <span data-unresolved-link="dev.inmo.micro_utils.coroutines.compose//&lt;this&gt;/#/PointingToCallableParameters(-1)/">this</span> to update returned State</p></div></div></div></div><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>use</span><wbr></wbr><span>Context</span><wbr></wbr><span>On</span><wbr></wbr><span><span>Change</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be used to change context inside of <a href="../dev.inmo.micro_utils.coroutines/subscribe-safely-without-exceptions.html">subscribeSafelyWithoutExceptions</a> to ensure that change will happen in the required <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a>. <span data-unresolved-link="kotlinx.coroutines/Dispatchers/Main/#/PointingToDeclaration/">Dispatchers.Main</span> by default</p></div></div></div></div><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>on</span><wbr></wbr><span><span>Exception</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be passed to the <a href="../dev.inmo.micro_utils.coroutines/subscribe-safely-without-exceptions.html">subscribeSafelyWithoutExceptions</a> as uncaught exceptions handler</p></div></div></div></div></div></div></div>
|
|
</div>
|
|
<div class="footer">
|
|
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
|
|
class="pull-right"><span>Generated by </span><a
|
|
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|