mirror of
https://github.com/InsanusMokrassar/MicroUtils.git
synced 2025-10-20 06:40:32 +00:00
deploy: ea497ea488
This commit is contained in:
InsanusMokrassar
@@ -66,7 +66,7 @@
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>Config</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">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">plugins<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/commonMain/kotlin/Config.kt#L20">source</a>)</span></span></div></div></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">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">plugins<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/commonMain/kotlin/Config.kt#L20">source</a>)</span></span></div></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
|
||||
|
||||
@@ -65,7 +65,7 @@
|
||||
<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><span class="current">Config</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>Config</span></span></h1>
|
||||
<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"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="kotlinx.serialization/Serializable///PointingToDeclaration/"><span class="token annotation builtin">Serializable</span></span></div></div><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">Config</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>plugins<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/commonMain/kotlin/Config.kt#L20">source</a>)</span></span></div><p class="paragraph">Contains just <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a> of <a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a>s. In json this config should look like:</p><div class="sample-container"><pre><code class="block lang-json" theme="idea">{<br> "plugins": [<br> "dev.inmo.micro_utils.startup.launcher.HelloWorldPlugin"<br> ]<br>}</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">In the sample above <a href="../-hello-world-plugin/index.html">HelloWorldPlugin</a> will be loaded during startup of application</p></div></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"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="kotlinx.serialization/Serializable///PointingToDeclaration/"><span class="token annotation builtin">Serializable</span></span></div></div><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">Config</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>plugins<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/commonMain/kotlin/Config.kt#L20">source</a>)</span></span></div><p class="paragraph">Contains just <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a> of <a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a>s. In json this config should look like:</p><div class="sample-container"><pre><code class="block lang-json" theme="idea">{<br> "plugins": [<br> "dev.inmo.micro_utils.startup.launcher.HelloWorldPlugin"<br> ]<br>}</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">In the sample above <a href="../-hello-world-plugin/index.html">HelloWorldPlugin</a> will be loaded during startup of application</p></div></div>
|
||||
</div>
|
||||
<div class="tabbedcontent">
|
||||
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
|
||||
@@ -82,7 +82,7 @@
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">plugins<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a><span class="token operator">></span></span></span><span class="token punctuation">)</span></div></div></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">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">plugins<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a><span class="token operator">></span></span></span><span class="token punctuation">)</span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -101,7 +101,7 @@
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">val </span><a href="plugins.html">plugins</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a><span class="token operator">></span></div></div></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">val </span><a href="plugins.html">plugins</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a><span class="token operator">></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -66,7 +66,7 @@
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>plugins</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">val </span><a href="plugins.html">plugins</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a><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/Config.kt#L21">source</a>)</span></span></div></div></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">val </span><a href="plugins.html">plugins</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a><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/Config.kt#L21">source</a>)</span></span></div></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
|
||||
|
||||
@@ -73,7 +73,7 @@
|
||||
<div data-togglable="FUNCTION">
|
||||
<h2 class="">Functions</h2>
|
||||
<div class="table"><a data-name="2124885536%2FFunctions%2F-1478683138" anchor-label="setupDI" id="2124885536%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
||||
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain">
|
||||
<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><a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/setup-d-i.html"><span>setup</span><wbr></wbr><span><span>DI</span></span></a></div>
|
||||
@@ -82,7 +82,7 @@
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">open </span><span class="token keyword"></span><span class="token keyword">fun </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/setup-d-i.html"><span class="token function">setupDI</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">config<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">This method will be called first to configure Module related to this plugin. You may use org.koin.core.scope.Scope.get in your koin definitions like Module.single to retrieve <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">kotlinx.coroutines.CoroutineScope</span>, <span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">kotlinx.serialization.json.Json</span> or <a href="../-config/index.html">dev.inmo.micro_utils.startup.launcher.Config</a></p></div></div></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">open </span><span class="token keyword">fun </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/setup-d-i.html"><span class="token function">setupDI</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">config<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">This method will be called first to configure Module related to this plugin. You may use org.koin.core.scope.Scope.get in your koin definitions like Module.single to retrieve <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">kotlinx.coroutines.CoroutineScope</span>, <span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">kotlinx.serialization.json.Json</span> or <a href="../-config/index.html">dev.inmo.micro_utils.startup.launcher.Config</a></p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -73,7 +73,7 @@
|
||||
<div data-togglable="FUNCTION">
|
||||
<h2 class="">Functions</h2>
|
||||
<div class="table"><a data-name="-774299611%2FFunctions%2F-1478683138" anchor-label="setupDI" id="-774299611%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
||||
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain">
|
||||
<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><a href="setup-d-i.html"><span>setup</span><wbr></wbr><span><span>DI</span></span></a></div>
|
||||
@@ -82,7 +82,7 @@
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="setup-d-i.html"><span class="token function">setupDI</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">config<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Will deserialize <a href="../-config/index.html">Config</a> from <a href="setup-d-i.html">config</a>, register it in receiver Module (as well as <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> and <span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">kotlinx.serialization.json.Json</span>)</p></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="setup-d-i.html"><span class="token function">setupDI</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 ">rawJsonObject<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span></div></div></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">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="setup-d-i.html"><span class="token function">setupDI</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">config<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Will deserialize <a href="../-config/index.html">Config</a> from <a href="setup-d-i.html">config</a>, register it in receiver Module (as well as <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> and <span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">kotlinx.serialization.json.Json</span>)</p></div><div class="symbol monospace"><span class="token keyword">fun </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="setup-d-i.html"><span class="token function">setupDI</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 ">rawJsonObject<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -112,7 +112,7 @@
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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></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></div><div class="brief "><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></div><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></div><div class="brief "><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></div><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></div><div class="brief "><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></div></div></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">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 data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">, </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="token operator">></span></div><div class="brief "><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></div><div class="symbol monospace"><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 data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">, </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="token operator">></span></div><div class="brief "><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></div><div class="symbol monospace"><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 data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">, </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="token operator">></span></div><div class="brief "><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></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -66,7 +66,7 @@
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>setup</span><wbr></wbr><span><span>DI</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 data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="setup-d-i.html"><span class="token function">setupDI</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 ">rawJsonObject<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/commonMain/kotlin/StartLauncherPlugin.kt#L32">source</a>)</span></span></div><br><hr><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="setup-d-i.html"><span class="token function">setupDI</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">config<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="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/commonMain/kotlin/StartLauncherPlugin.kt#L79">source</a>)</span></span></div><p class="paragraph">Will deserialize <a href="../-config/index.html">Config</a> from <a href="setup-d-i.html">config</a>, register it in receiver Module (as well as <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> and <span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">kotlinx.serialization.json.Json</span>)</p><p class="paragraph">Besides, in this method will be called <a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/setup-d-i.html">StartPlugin.setupDI</a> on each plugin from <a href="../-config/plugins.html">Config.plugins</a>. In case when some plugin will not be loaded correctly it will be reported throw the <span data-unresolved-link="dev.inmo.micro_utils.startup.launcher/StartLauncherPlugin/logger/#/PointingToDeclaration/">logger</span></p></div></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">fun </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="setup-d-i.html"><span class="token function">setupDI</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 ">rawJsonObject<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/JsonObject///PointingToDeclaration/">JsonObject</span><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/commonMain/kotlin/StartLauncherPlugin.kt#L32">source</a>)</span></span></div><br><hr><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="setup-d-i.html"><span class="token function">setupDI</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">config<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="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/commonMain/kotlin/StartLauncherPlugin.kt#L79">source</a>)</span></span></div><p class="paragraph">Will deserialize <a href="../-config/index.html">Config</a> from <a href="setup-d-i.html">config</a>, register it in receiver Module (as well as <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> and <span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">kotlinx.serialization.json.Json</span>)</p><p class="paragraph">Besides, in this method will be called <a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/setup-d-i.html">StartPlugin.setupDI</a> on each plugin from <a href="../-config/plugins.html">Config.plugins</a>. In case when some plugin will not be loaded correctly it will be reported throw the <span data-unresolved-link="dev.inmo.micro_utils.startup.launcher/StartLauncherPlugin/logger/#/PointingToDeclaration/">logger</span></p></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -66,7 +66,7 @@
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>base</span><wbr></wbr><span>Json</span><wbr></wbr><span>Provider</span><wbr></wbr><span><span>Factory</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 data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider-factory.html"><span class="token function">baseJsonProviderFactory</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">definition<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><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">></span></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><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</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/GeneratedDefinitionsStartLauncherPlugin.kt#L37">source</a>)</span></span></div><p class="paragraph">Will register <a href="base-json-provider-factory.html">definition</a> with org.koin.core.module.Module.factory and key "baseJsonProvider"</p></div></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">fun </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider-factory.html"><span class="token function">baseJsonProviderFactory</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">definition<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 data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">></span></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 data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</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/GeneratedDefinitionsStartLauncherPlugin.kt#L37">source</a>)</span></span></div><p class="paragraph">Will register <a href="base-json-provider-factory.html">definition</a> with org.koin.core.module.Module.factory and key "baseJsonProvider"</p></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
|
||||
|
||||
@@ -66,7 +66,7 @@
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>base</span><wbr></wbr><span>Json</span><wbr></wbr><span>Provider</span><wbr></wbr><span><span>Single</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 data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider-single.html"><span class="token function">baseJsonProviderSingle</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">createdAtStart<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter ">definition<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><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">></span></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><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</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/GeneratedDefinitionsStartLauncherPlugin.kt#L30">source</a>)</span></span></div><p class="paragraph">Will register <a href="base-json-provider-single.html">definition</a> with org.koin.core.module.Module.single and key "baseJsonProvider"</p></div></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">fun </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider-single.html"><span class="token function">baseJsonProviderSingle</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">createdAtStart<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter ">definition<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 data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">></span></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 data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</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/GeneratedDefinitionsStartLauncherPlugin.kt#L30">source</a>)</span></span></div><p class="paragraph">Will register <a href="base-json-provider-single.html">definition</a> with org.koin.core.module.Module.single and key "baseJsonProvider"</p></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
|
||||
|
||||
@@ -66,7 +66,7 @@
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>base</span><wbr></wbr><span>Json</span><wbr></wbr><span><span>Provider</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">val </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider.html">baseJsonProvider</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</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/GeneratedDefinitionsStartLauncherPlugin.kt#L18">source</a>)</span></span></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider.html">baseJsonProvider</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</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/GeneratedDefinitionsStartLauncherPlugin.kt#L24">source</a>)</span></span></div><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">Definition by key "baseJsonProvider"</p></span></div></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">val </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider.html">baseJsonProvider</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</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/GeneratedDefinitionsStartLauncherPlugin.kt#L18">source</a>)</span></span></div><div class="symbol monospace"><span class="token keyword">val </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider.html">baseJsonProvider</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</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/GeneratedDefinitionsStartLauncherPlugin.kt#L24">source</a>)</span></span></div><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">Definition by key "baseJsonProvider"</p></span></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
|
||||
|
||||
@@ -66,7 +66,7 @@
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>default</span><wbr></wbr><span><span>Json</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">val </span><a href="default-json.html">defaultJson</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/commonMain/kotlin/DefaultJson.kt#L5">source</a>)</span></span></div></div></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">val </span><a href="default-json.html">defaultJson</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/commonMain/kotlin/DefaultJson.kt#L5">source</a>)</span></span></div></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
|
||||
|
||||
@@ -82,7 +82,7 @@
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="kotlinx.serialization/Serializable///PointingToDeclaration/"><span class="token annotation builtin">Serializable</span></span></div></div><span class="token keyword">data </span><span class="token keyword">class </span><a href="-config/index.html">Config</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>plugins<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a><span class="token operator">></span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Contains just <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a> of <a href="../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a>s. In json this config should look like:</p></div></div></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"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="kotlinx.serialization/Serializable///PointingToDeclaration/"><span class="token annotation builtin">Serializable</span></span></div></div><span class="token keyword">data </span><span class="token keyword">class </span><a href="-config/index.html">Config</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>plugins<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><a href="../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a><span class="token operator">></span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Contains just <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a> of <a href="../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a>s. In json this config should look like:</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -131,7 +131,7 @@
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">val </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider.html">baseJsonProvider</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">?</span></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider.html">baseJsonProvider</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">?</span></div></div></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">val </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider.html">baseJsonProvider</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">?</span></div><div class="symbol monospace"><span class="token keyword">val </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider.html">baseJsonProvider</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">?</span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -146,7 +146,7 @@
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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">val </span><a href="default-json.html">defaultJson</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span></div></div></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">val </span><a href="default-json.html">defaultJson</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -165,7 +165,7 @@
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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 data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider-factory.html"><span class="token function">baseJsonProviderFactory</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">definition<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><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">></span></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><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">></span></div><div class="brief "><p class="paragraph">Will register <a href="base-json-provider-factory.html">definition</a> with org.koin.core.module.Module.factory and key "baseJsonProvider"</p></div></div></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">fun </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider-factory.html"><span class="token function">baseJsonProviderFactory</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">definition<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 data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">></span></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 data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">></span></div><div class="brief "><p class="paragraph">Will register <a href="base-json-provider-factory.html">definition</a> with org.koin.core.module.Module.factory and key "baseJsonProvider"</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -180,7 +180,7 @@
|
||||
</span></span></div>
|
||||
<div>
|
||||
<div class="title">
|
||||
<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 data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider-single.html"><span class="token function">baseJsonProviderSingle</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">createdAtStart<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter ">definition<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><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">></span></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><span data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">></span></div><div class="brief "><p class="paragraph">Will register <a href="base-json-provider-single.html">definition</a> with org.koin.core.module.Module.single and key "baseJsonProvider"</p></div></div></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">fun </span><span data-unresolved-link="/&lt;Error class: unknown class&gt;///PointingToDeclaration/"><Error class: unknown class></span><span class="token punctuation">.</span><a href="base-json-provider-single.html"><span class="token function">baseJsonProviderSingle</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">createdAtStart<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter ">definition<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 data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">></span></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 data-unresolved-link="kotlinx.serialization.json/Json///PointingToDeclaration/">Json</span><span class="token operator">></span></div><div class="brief "><p class="paragraph">Will register <a href="base-json-provider-single.html">definition</a> with org.koin.core.module.Module.single and key "baseJsonProvider"</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -197,7 +197,7 @@
|
||||
<div class="title">
|
||||
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
|
||||
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
|
||||
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="main.html"><span class="token function">main</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">args<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">></span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">It is expected, that <a href="main.html">args</a> will contain ONE argument with path to the config json. Sample of launching:</p></div></div> </div>
|
||||
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="main.html"><span class="token function">main</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">args<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">></span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">It is expected, that <a href="main.html">args</a> will contain ONE argument with path to the config json. Sample of launching:</p></div></div> </div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -68,7 +68,7 @@
|
||||
</div>
|
||||
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
|
||||
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
|
||||
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="main.html"><span class="token function">main</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">args<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/jvmMain/kotlin/Main.kt#L43">source</a>)</span></span></div><p class="paragraph">It is expected, that <a href="main.html">args</a> will contain ONE argument with path to the config json. Sample of launching:</p><div class="sample-container"><pre><code class="block lang-bash" theme="idea">./gradlew run --args="sample.config.json"</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">Content of <code class="lang-kotlin">sample.config.json</code> described in <a href="-config/index.html">Config</a> KDocs.</p><p class="paragraph">You may build runnable app using:</p><div class="sample-container"><pre><code class="block lang-bash" theme="idea">./gradlew assembleDist</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">In that case in <code class="lang-kotlin">build/distributions</code> folder you will be able to find zip and tar files with all required tools for application running (via their <code class="lang-kotlin">bin/app_name</code> binary). In that case yoy will not need to pass <code class="lang-kotlin">--args=...</code> and launch will look like <code class="lang-kotlin">./bin/app_name sample.config.json</code></p><h2 class=""> Debug mode</h2><p class="paragraph">You may pass the second parameter, one of LogLevel enum variants to setup KSLog minimal logging level. Sample:</p><div class="sample-container"><pre><code class="block lang-bash" theme="idea">./gradlew run --args="sample.config.json DEBUG" // enable debugging output</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">OR</p><div class="sample-container"><pre><code class="block lang-bash" theme="idea">./gradlew run --args="sample.config.json WARNING" // enable logging since WARNING</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph"><strong>Default level is </strong><strong>LogLevel.INFO</strong></p></div> </div>
|
||||
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="main.html"><span class="token function">main</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">args<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//startup/launcher/src/jvmMain/kotlin/Main.kt#L43">source</a>)</span></span></div><p class="paragraph">It is expected, that <a href="main.html">args</a> will contain ONE argument with path to the config json. Sample of launching:</p><div class="sample-container"><pre><code class="block lang-bash" theme="idea">./gradlew run --args="sample.config.json"</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">Content of <code class="lang-kotlin">sample.config.json</code> described in <a href="-config/index.html">Config</a> KDocs.</p><p class="paragraph">You may build runnable app using:</p><div class="sample-container"><pre><code class="block lang-bash" theme="idea">./gradlew assembleDist</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">In that case in <code class="lang-kotlin">build/distributions</code> folder you will be able to find zip and tar files with all required tools for application running (via their <code class="lang-kotlin">bin/app_name</code> binary). In that case yoy will not need to pass <code class="lang-kotlin">--args=...</code> and launch will look like <code class="lang-kotlin">./bin/app_name sample.config.json</code></p><h2 class="">Debug mode</h2><p class="paragraph">You may pass the second parameter, one of LogLevel enum variants to setup KSLog minimal logging level. Sample:</p><div class="sample-container"><pre><code class="block lang-bash" theme="idea">./gradlew run --args="sample.config.json DEBUG" // enable debugging output</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">OR</p><div class="sample-container"><pre><code class="block lang-bash" theme="idea">./gradlew run --args="sample.config.json WARNING" // enable logging since WARNING</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph"><strong>Default level is </strong><strong>LogLevel.INFO</strong></p></div> </div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
|
||||
|
||||
Reference in New Issue
Block a user