mirror of
https://github.com/InsanusMokrassar/MicroUtils.git
synced 2025-12-20 13:15:49 +00:00
deploy: 9171d5ed11
This commit is contained in:
@@ -61,7 +61,7 @@
|
||||
<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></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,FUNCTION,PROPERTY">Members</button></div>
|
||||
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
|
||||
<div class="tabs-section-body">
|
||||
<div data-togglable="CONSTRUCTOR">
|
||||
<h2 class="">Constructors</h2>
|
||||
|
||||
@@ -61,7 +61,7 @@
|
||||
<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">object </span><a href="index.html">HelloWorldPlugin</a> : <a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a></div></div></div>
|
||||
</div>
|
||||
<div class="tabbedcontent">
|
||||
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,FUNCTION,PROPERTY">Members</button></div>
|
||||
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
|
||||
<div class="tabs-section-body">
|
||||
<div data-togglable="FUNCTION">
|
||||
<h2 class="">Functions</h2>
|
||||
|
||||
@@ -61,7 +61,7 @@
|
||||
<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">object </span><a href="index.html">StartLauncherPlugin</a> : <a href="../../dev.inmo.micro_utils.startup.plugin/-start-plugin/index.html">StartPlugin</a></div><p class="paragraph">Default startup plugin. See <a href="setup-d-i.html">setupDI</a> and <a href="start-plugin.html">startPlugin</a> for more info</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,FUNCTION,PROPERTY">Members</button></div>
|
||||
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
|
||||
<div class="tabs-section-body">
|
||||
<div data-togglable="FUNCTION">
|
||||
<h2 class="">Functions</h2>
|
||||
|
||||
@@ -112,6 +112,40 @@
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div data-togglable="PROPERTY">
|
||||
<h2 class="">Properties</h2>
|
||||
<div class="table"><a data-name="-1950132985%2FProperties%2F-1478683138" anchor-label="baseJsonProvider" id="-1950132985%2FProperties%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
||||
<div class="table-row" data-togglable="EXTENSION_PROPERTY" 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="base-json-provider.html"><span>base</span><wbr></wbr><span>Json</span><wbr></wbr><span><span>Provider</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1950132985%2FProperties%2F-1478683138"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="2064689291%2FProperties%2F-1478683138" anchor-label="defaultJson" id="2064689291%2FProperties%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
||||
<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="default-json.html"><span>default</span><wbr></wbr><span><span>Json</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2064689291%2FProperties%2F-1478683138"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div data-togglable="FUNCTION">
|
||||
<h2 class="">Functions</h2>
|
||||
<div class="table"><a data-name="1605572558%2FFunctions%2F-1478683138" anchor-label="baseJsonProviderFactory" id="1605572558%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
||||
@@ -163,40 +197,6 @@
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div data-togglable="PROPERTY">
|
||||
<h2 class="">Properties</h2>
|
||||
<div class="table"><a data-name="-1950132985%2FProperties%2F-1478683138" anchor-label="baseJsonProvider" id="-1950132985%2FProperties%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
||||
<div class="table-row" data-togglable="EXTENSION_PROPERTY" 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="base-json-provider.html"><span>base</span><wbr></wbr><span>Json</span><wbr></wbr><span><span>Provider</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1950132985%2FProperties%2F-1478683138"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<a data-name="2064689291%2FProperties%2F-1478683138" anchor-label="defaultJson" id="2064689291%2FProperties%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
||||
<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="default-json.html"><span>default</span><wbr></wbr><span><span>Json</span></span></a></div>
|
||||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2064689291%2FProperties%2F-1478683138"></span>
|
||||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -61,7 +61,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></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 <span data-unresolved-link="dev.inmo.micro_utils.startup.launcher/Config///PointingToDeclaration/">Config</span> 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><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><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>© 2023 Copyright</span><span
|
||||
|
||||
Reference in New Issue
Block a user