MicroUtils/micro_utils.dokka/dev.inmo.micro_utils.startup.plugin/index.html
2023-11-29 20:04:20 +00:00

144 lines
17 KiB
HTML

<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>dev.inmo.micro_utils.startup.plugin</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../styles/style.css" rel="Stylesheet">
<link href="../../styles/main.css" rel="Stylesheet">
<link href="../../styles/prism.css" rel="Stylesheet">
<link href="../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../index.html">
micro_utils.dokka
</a>
</div>
<div class="library-version">
0.20.16 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/commonMain">common</button>
<button class="platform-tag platform-selector js-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/jsMain">js</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="package" id="content" pageIds="micro_utils.dokka::dev.inmo.micro_utils.startup.plugin////PointingToDeclaration//-612354790">
<div class="breadcrumbs"><a href="../../index.html">micro_utils.dokka</a><span class="delimiter">/</span><span class="current">dev.inmo.micro_utils.startup.plugin</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="TYPE">Types</button><button class="section-tab" data-togglable="FUNCTION,EXTENSION_FUNCTION">Functions</button></div>
<div class="tabs-section-body">
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="-2145106815%2FClasslikes%2F-1478683138" anchor-label="StartPlugin" id="-2145106815%2FClasslikes%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="-start-plugin/index.html"><span>Start</span><wbr></wbr><span><span>Plugin</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2145106815%2FClasslikes%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"><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><span class="token punctuation">(</span><span>with<span class="token operator"> = </span><a href="-start-plugin-serializer/index.html">StartPluginSerializer::class</a></span><wbr></wbr><span class="token punctuation">)</span></div></div><span class="token keyword">interface </span><a href="-start-plugin/index.html">StartPlugin</a></div><div class="brief "><p class="paragraph">Default plugin for start of your app</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1469695217%2FClasslikes%2F-612354790" anchor-label="StartPluginSerializer" id="-1469695217%2FClasslikes%2F-612354790" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain,:micro_utils.dokka:dokkaHtml/jsMain,:micro_utils.dokka:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain,:micro_utils.dokka:dokkaHtml/jsMain,:micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain,:micro_utils.dokka:dokkaHtml/jsMain,:micro_utils.dokka:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-start-plugin-serializer/index.html"><span>Start</span><wbr></wbr><span>Plugin</span><wbr></wbr><span><span>Serializer</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1469695217%2FClasslikes%2F-612354790"></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 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/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":micro_utils.dokka:dokkaHtml/jsMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jsMain" data-toggle=":micro_utils.dokka:dokkaHtml/jsMain">js</button><button class="platform-bookmark" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain" data-toggle=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">expect </span><span class="token keyword">object </span><a href="-start-plugin-serializer/index.html">StartPluginSerializer</a> : <span data-unresolved-link="kotlinx.serialization/KSerializer///PointingToDeclaration/">KSerializer</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-start-plugin/index.html">StartPlugin</a><span class="token operator">&gt; </span></div></div><div class="content sourceset-dependent-content" data-togglable=":micro_utils.dokka:dokkaHtml/jsMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">object </span><a href="-start-plugin-serializer/index.html">StartPluginSerializer</a> : <span data-unresolved-link="kotlinx.serialization/KSerializer///PointingToDeclaration/">KSerializer</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-start-plugin/index.html">StartPlugin</a><span class="token operator">&gt; </span></div></div><div class="content sourceset-dependent-content" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">actual </span><span class="token keyword">object </span><a href="-start-plugin-serializer/index.html">StartPluginSerializer</a> : <span data-unresolved-link="kotlinx.serialization/KSerializer///PointingToDeclaration/">KSerializer</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-start-plugin/index.html">StartPlugin</a><span class="token operator">&gt; </span></div></div> </div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="598401085%2FFunctions%2F-119510368" anchor-label="createStartupPluginAndRegister" id="598401085%2FFunctions%2F-119510368" data-filterable-set=":micro_utils.dokka:dokkaHtml/jsMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/jsMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jsMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="create-startup-plugin-and-register.html"><span>create</span><wbr></wbr><span>Startup</span><wbr></wbr><span>Plugin</span><wbr></wbr><span>And</span><wbr></wbr><span><span>Register</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="598401085%2FFunctions%2F-119510368"></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 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/jsMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jsMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/jsMain">js</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/jsMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="create-startup-plugin-and-register.html">T</a><span class="token operator"> : </span><a href="-start-plugin/index.html">StartPlugin</a><span class="token operator">&gt; </span><a href="create-startup-plugin-and-register.html"><span class="token function">createStartupPluginAndRegister</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">block<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="create-startup-plugin-and-register.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="create-startup-plugin-and-register.html">T</a></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="create-startup-plugin-and-register.html">T</a><span class="token operator"> : </span><a href="-start-plugin/index.html">StartPlugin</a><span class="token operator">&gt; </span><a href="create-startup-plugin-and-register.html"><span class="token function">createStartupPluginAndRegister</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">name<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>uuid4().toString()<span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="create-startup-plugin-and-register.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="create-startup-plugin-and-register.html">T</a></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="create-startup-plugin-and-register.html">T</a><span class="token operator"> : </span><a href="-start-plugin/index.html">StartPlugin</a><span class="token operator">&gt; </span><a href="create-startup-plugin-and-register.html"><span class="token function">createStartupPluginAndRegister</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">kClass<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="create-startup-plugin-and-register.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">name<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>uuid4().toString()<span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="create-startup-plugin-and-register.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="create-startup-plugin-and-register.html">T</a></div><div class="brief "><p class="paragraph">Creates <a href="create-startup-plugin-and-register.html">T</a> using <a href="create-startup-plugin-and-register.html">block</a>, register it in <a href="-start-plugin-serializer/index.html">StartPluginSerializer</a> using its <a href="-start-plugin-serializer/register-plugin.html">StartPluginSerializer.registerPlugin</a> and returns created by <a href="create-startup-plugin-and-register.html">block</a> plugin</p></div></div> </div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>