2023-02-22 04:40:54 +00:00
<!DOCTYPE html>
< html >
< head >
< meta name = "viewport" content = "width=device-width, initial-scale=1" charset = "UTF-8" >
< title > GenerateKoinDefinition< / title >
< link href = "../../../images/logo-icon.svg" rel = "icon" type = "image/svg" >
< script > var pathToRoot = "../../../" ; < / script >
< script > c o n s t s t o r a g e = l o c a l S t o r a g e . g e t I t e m ( " d o k k a - d a r k - m o d e " )
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 = "../../../scripts/sourceset_dependencies.js" async = "async" > < / script >
< link href = "../../../styles/style.css" rel = "Stylesheet" >
< link href = "../../../styles/jetbrains-mono.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" >
< 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 = "navigation-wrapper" id = "navigation-wrapper" >
< div id = "leftToggler" > < span class = "icon-toggler" > < / span > < / div >
< div class = "library-name" >
< a href = "../../../index.html" >
< span > micro_utils.dokka< / span >
< / a >
< / div >
< div >
2023-02-28 13:46:23 +00:00
0.17.1 < / div >
2023-02-22 04:40:54 +00:00
< div class = "pull-right d-flex" >
< div class = "filter-section" id = "filter-section" >
< button class = "platform-tag platform-selector common-like" data-active = "" data-filter = ":micro_utils.dokka:dokkaHtml/commonMain" > common< / button >
< / div >
< button id = "theme-toggle-button" > < span id = "theme-toggle" > < / span > < / button >
< div id = "searchBar" > < / div >
< / div >
< / div >
< div id = "container" >
< div id = "leftColumn" >
< div id = "sideMenu" > < / div >
< / div >
< div id = "main" >
< div class = "main-content" id = "content" pageIds = "micro_utils.dokka::dev.inmo.micro_utils.koin.annotations/GenerateKoinDefinition///PointingToDeclaration//-1478683138" >
< div class = "breadcrumbs" > < a href = "../../../index.html" > micro_utils.dokka< / a > < span class = "delimiter" > /< / span > < a href = "../index.html" > dev.inmo.micro_utils.koin.annotations< / a > < span class = "delimiter" > /< / span > < span class = "current" > GenerateKoinDefinition< / span > < / div >
< div class = "cover " >
< h1 class = "cover" > < span > Generate< / span > < wbr > < / wbr > < span > Koin< / span > < wbr > < / wbr > < span > < span > Definition< / 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 > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html" > < span class = "token annotation builtin" > Target< / span > < / a > < span class = "token punctuation" > (< / span > < span > allowedTargets< span class = "token operator" > = < / span > < span class = "token punctuation" > [< / span > < span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-f-i-l-e/index.html" > AnnotationTarget.FILE< / a > < / span > < wbr > < / wbr > < span class = "token punctuation" > ]< / span > < / span > < wbr > < / wbr > < span class = "token punctuation" > )< / span > < / div > < / div > < span class = "token keyword" > annotation class < / span > < a href = "index.html" > GenerateKoinDefinition< / a > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > < span class = "token keyword" > val < / span > name< span class = "token operator" > : < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html" > String< / a > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > < span class = "token keyword" > val < / span > type< 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" > < < / span > < span class = "token operator" > *< / span > < span class = "token operator" > > < / span > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > < span class = "token keyword" > val < / span > typeArgs< 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" > < < / span > < span class = "token operator" > *< / span > < span class = "token operator" > > < / span > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > < span class = "token keyword" > val < / span > nullable< 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" > true< / span > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > < span class = "token keyword" > val < / span > generateSingle< 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" > true< / span > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > < span class = "token keyword" > val < / span > generateFactory< 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" > true< / span > < / span > < / span > < span class = "token punctuation" > )< / span > < / div > < p class = "paragraph" > Use this annotation to mark files near to which generator should place generated extensions for koin org.koin.core.scope.Scope and org.koin.core.Koin< / p > < / div > < / div >
< / div >
< div class = "tabbedcontent" >
< div class = "tabs-section" tabs-section = "tabs-section" > < button class = "section-tab" data-active = "" data-togglable = "Properties" > Properties< / button > < button class = "section-tab" data-togglable = "Parameters" > Parameters< / button > < / div >
< div class = "tabs-section-body" >
< h4 class = "" > Parameters< / h4 >
< div data-togglable = "Parameters" >
< div class = "platform-hinted WithExtraAttributes" data-platform-hinted = "data-platform-hinted" data-togglable = "Parameters" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < div data-togglable = "Parameters" > < div class = "table" data-togglable = "Parameters" > < 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 WithExtraAttributes" > < div class = "" > < span class = "inline-flex" > < div > < u > < span > < span > name< / span > < / span > < / u > < / div > < / span > < / div > < div > < div class = "title" > < div data-togglable = "Parameters" > < p class = "paragraph" > Name for definitions. This name will be available as extension for org.koin.core.scope.Scope and org.koin.core.Koin< / p > < / div > < / div > < / div > < / div > < / div > < div class = "table-row" data-filterable-current = ":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < div class = "main-subrow keyValue WithExtraAttributes" > < div class = "" > < span class = "inline-flex" > < div > < u > < span > < span > type< / span > < / span > < / u > < / div > < / span > < / div > < div > < div class = "title" > < div data-togglable = "Parameters" > < p class = "paragraph" > Type of extensions. It is base star-typed class< / p > < / div > < / div > < / div > < / div > < / div > < div class = "table-row" data-filterable-current = ":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < div class = "main-subrow keyValue WithExtraAttributes" > < div class = "" > < span class = "inline-flex" > < div > < u > < span > type< / span > < wbr > < / wbr > < span > < span > Args< / span > < / span > < / u > < / div > < / span > < / div > < div > < div class = "title" > < div data-togglable = "Parameters" > < p class = "paragraph" > Generic types for < a href = "type.html" > type< / a > . For example, if < a href = "type.html" > type< / a > == < code class = "lang-kotlin" > Something::class< / code > and < a href = "type-args.html" > typeArgs< / a > == < code class = "lang-kotlin" > G1::class, G2::class< / code > , the result type will be < code class = "lang-kotlin" > Something< G1, G2> < / code > < / p > < / div > < / div > < / div > < / div > < / div > < div class = "table-row" data-filterable-current = ":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < div class = "main-subrow keyValue WithExtraAttributes" > < div class = "" > < span class = "inline-flex" > < div > < u > < span > < span > nullable< / span > < / span > < / u > < / div > < / span > < / div > < div > < div class = "title" > < div data-togglable = "Parameters" > < p class = "paragraph" > In case when true, extension will not throw error when definition has not been registered in koin< / p > < / div > < / div > < / div > < / div > < / div > < div class = "table-row" data-filterable-current = ":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < div class = "main-subrow keyValue WithExtraAttributes" > < div class = "" > < span class = "inline-flex" > < div > < u > < span > generate< / span > < wbr > < / wbr > < span > < span > Single< / span > < / span > < / u > < / div > < / span > < / div > < div > < div class = "title" > < div data-togglable = "Parameters" > < p class = "paragraph" > Generate definition factory with org.koin.core.module.Module.single. You will be able to use the extension org.koin.core.module.Module.< a href = "name.html" > name< / a > Single(createdAtStart/* default false < i > /) { /< / i > your definition */ }< / p > < / div > < / div > < / div > < / div > < / div > < div class = "table-row" data-filterable-current = ":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < div class = "main-subrow keyValue WithExtraAttributes" > < div class = "" > < span class = "inline-flex" > < div > < u > < span > generate< / span > < wbr > < / wbr > < span > < span > Factory< / span > < / span > < / u > < / div > < / span > < / div > < div > < div class = "title" > < div data-togglable = "Parameters" > < p class = "paragraph" > Generate definition factory with org.koin.core.module.Module.factory. You will be able to use the extension org.koin.core.module.Module.< a href = "name.html" > name< / a > Factory { /* your definition */ }< / p > < / div > < / div > < / div > < / div > < / div > < / div > < / div > < / div > < / div >
< / div >
< h2 class = "" > Properties< / h2 >
< div class = "table" data-togglable = "Properties" > < a data-name = "522785340%2FProperties%2F-1478683138" anchor-label = "generateFactory" id = "522785340%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 = "generate-factory.html" > < span > generate< / span > < wbr > < / wbr > < span > < span > Factory< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "522785340%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" data-togglable = "Properties" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < a data-name = "522785340%2FProperties%2F-1478683138" anchor-label = "generateFactory" id = "522785340%2FProperties%2F-1478683138" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < / a > < div class = "symbol monospace" > < span class = "token keyword" > < / span > < span class = "token keyword" > val < / span > < a href = "generate-factory.html" > generateFactory< / a > < 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" > true< / span > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< a data-name = "-1180232948%2FProperties%2F-1478683138" anchor-label = "generateSingle" id = "-1180232948%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 = "generate-single.html" > < span > generate< / span > < wbr > < / wbr > < span > < span > Single< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1180232948%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" data-togglable = "Properties" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < a data-name = "-1180232948%2FProperties%2F-1478683138" anchor-label = "generateSingle" id = "-1180232948%2FProperties%2F-1478683138" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < / a > < div class = "symbol monospace" > < span class = "token keyword" > < / span > < span class = "token keyword" > val < / span > < a href = "generate-single.html" > generateSingle< / a > < 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" > true< / span > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< a data-name = "-1861617314%2FProperties%2F-1478683138" anchor-label = "name" id = "-1861617314%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 = "name.html" > < span > < span > name< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1861617314%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" data-togglable = "Properties" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < a data-name = "-1861617314%2FProperties%2F-1478683138" anchor-label = "name" id = "-1861617314%2FProperties%2F-1478683138" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < / a > < div class = "symbol monospace" > < span class = "token keyword" > < / span > < span class = "token keyword" > val < / span > < a href = "name.html" > name< / a > < span class = "token operator" > : < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html" > String< / a > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< a data-name = "-1299944632%2FProperties%2F-1478683138" anchor-label = "nullable" id = "-1299944632%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 = "nullable.html" > < span > < span > nullable< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1299944632%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" data-togglable = "Properties" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < a data-name = "-1299944632%2FProperties%2F-1478683138" anchor-label = "nullable" id = "-1299944632%2FProperties%2F-1478683138" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < / a > < div class = "symbol monospace" > < span class = "token keyword" > < / span > < span class = "token keyword" > val < / span > < a href = "nullable.html" > nullable< / a > < 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" > true< / span > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< a data-name = "-931842161%2FProperties%2F-1478683138" anchor-label = "type" id = "-931842161%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 = "type.html" > < span > < span > type< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-931842161%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" data-togglable = "Properties" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < a data-name = "-931842161%2FProperties%2F-1478683138" anchor-label = "type" id = "-931842161%2FProperties%2F-1478683138" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < / a > < div class = "symbol monospace" > < span class = "token keyword" > < / span > < span class = "token keyword" > val < / span > < a href = "type.html" > type< / a > < 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" > < < / span > < span class = "token operator" > *< / span > < span class = "token operator" > > < / span > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< a data-name = "-207658958%2FProperties%2F-1478683138" anchor-label = "typeArgs" id = "-207658958%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 = "type-args.html" > < span > type< / span > < wbr > < / wbr > < span > < span > Args< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-207658958%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" data-togglable = "Properties" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < a data-name = "-207658958%2FProperties%2F-1478683138" anchor-label = "typeArgs" id = "-207658958%2FProperties%2F-1478683138" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < / a > < div class = "symbol monospace" > < span class = "token keyword" > < / span > < span class = "token keyword" > val < / span > < a href = "type-args.html" > typeArgs< / a > < 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" > out < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html" > KClass< / a > < span class = "token operator" > < < / span > < span class = "token operator" > *< / span > < span class = "token operator" > > < / span > < span class = "token operator" > > < / span > < / 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 >
< / body >
< / html >
