mirror of
https://github.com/InsanusMokrassar/MicroUtils.git
synced 2024-11-07 17:03:49 +00:00
81 lines
13 KiB
HTML
81 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html class="no-js">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>startAsync</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.13 </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.startup.launcher/StartLauncherPlugin/startAsync/#dev.inmo.micro_utils.startup.launcher.Config#kotlinx.serialization.json.JsonObject/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.startup.launcher</a><span class="delimiter">/</span><a href="index.html">StartLauncherPlugin</a><span class="delimiter">/</span><span class="current">startAsync</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>start</span><wbr></wbr><span><span>Async</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><a href="start-async.html"><span class="token function">startAsync</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">config<span class="token operator">: </span><a href="../-config/index.html">Config</a><span class="token punctuation">, </span></span><span class="parameter ">rawConfig<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator"><</span><span class="token keyword"></span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">, </span><span class="token keyword"></span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="token operator">></span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/commonMain/kotlin/StartLauncherPlugin.kt#L125">source</a>)</span></span></div><p class="paragraph">Will create KoinApplication, init, load modules using <a href="index.html">StartLauncherPlugin</a> and start plugins using the same base plugin. It is basic <a href="start.html">start</a> method which accepts both <a href="start-async.html">config</a> and <a href="start-async.html">rawConfig</a> which suppose to be the same or at least <a href="start-async.html">rawConfig</a> must contain serialized variant of <a href="start-async.html">config</a>.</p><p class="paragraph">Koin part will be started in-place. This means, that after ending of this method call you will be able to take any declared dependency from koin</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">KoinApplication of current start and <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span> which can be used to call CoroutineScope.join</p></span><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>raw</span><wbr></wbr><span><span>Config</span></span></u></div></span></div><div><div class="title"><p class="paragraph">It is expected that this <span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span> will contain serialized <a href="../-config/index.html">Config</a> (<a href="index.html">StartLauncherPlugin</a> will deserialize it in its <a href="setup-d-i.html">StartLauncherPlugin.setupDI</a></p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="start-async.html"><span class="token function">startAsync</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">rawConfig<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator"><</span><span class="token keyword"></span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">, </span><span class="token keyword"></span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="token operator">></span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/commonMain/kotlin/StartLauncherPlugin.kt#L172">source</a>)</span></span></div><p class="paragraph">Call <a href="start.html">start</a> with deserialized <a href="../-config/index.html">Config</a> as config and <a href="start-async.html">rawConfig</a> as is</p><p class="paragraph">Koin part will be started in-place. This means, that after ending of this method call you will be able to take any declared dependency from koin</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">KoinApplication of current launch and <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span> of starting launch</p></span><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>raw</span><wbr></wbr><span><span>Config</span></span></u></div></span></div><div><div class="title"><p class="paragraph">It is expected that this <span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span> will contain serialized <a href="../-config/index.html">Config</a></p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="start-async.html"><span class="token function">startAsync</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">config<span class="token operator">: </span><a href="../-config/index.html">Config</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator"><</span><span class="token keyword"></span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">, </span><span class="token keyword"></span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="token operator">></span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/commonMain/kotlin/StartLauncherPlugin.kt#L204">source</a>)</span></span></div><p class="paragraph">Call <a href="start.html">start</a> with deserialized <a href="../-config/index.html">Config</a> as is and serialize it to <span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span> to pass as the first parameter to the basic <a href="start.html">start</a> method</p><p class="paragraph">Koin part will be started in-place. This means, that after ending of this method call you will be able to take any declared dependency from koin</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">KoinApplication of current launch and <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span> of starting launch</p></span><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>config</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be converted to <span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span> as raw config. That means that all plugins from <a href="start-async.html">config</a> will receive serialized version of <a href="start-async.html">config</a> in <a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/setup-d-i.html">StartPlugin.setupDI</a> method</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>
|