koin-core/org.koin.core.module/Module

Module

class Module(_createdAtStart: Boolean = false)

Koin Module Gather/help compose Koin definitions

Author

Arnaud Giuliani

Constructors

Link copied to clipboard
constructor(_createdAtStart: Boolean = false)

Properties

Link copied to clipboard
Link copied to clipboard
val id: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
inline fun <T> factory(qualifier: Qualifier? = null, noinline definition: Definition<T>): KoinDefinition<T>

Declare a Factory definition

Link copied to clipboard
fun <T : Any> Module.factory(kClass: KClass<T>, qualifier: Qualifier? = null, definition: Definition<T>, scopeQualifier: Qualifier = ScopeRegistry.rootScopeQualifier): KoinDefinition<T>

Create a factory

Link copied to clipboard
inline fun <R> Module.factoryOf(crossinline constructor: () -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>

Declare a Module.factory definition by resolving a constructor reference for the dependency. The resolution is done at compile time by leveraging inline functions, no reflection is required.

inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1> Module.factoryOf(crossinline constructor: (T1) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2> Module.factoryOf(crossinline constructor: (T1, T2) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3> Module.factoryOf(crossinline constructor: (T1, T2, T3) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9> Module.factoryOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
fun includes(module: Collection<Module>)
fun includes(vararg module: Module)

A collection of Module from which the current Module is compose. Duplicated modules are ignored.

Link copied to clipboard
fun indexPrimaryType(instanceFactory: InstanceFactory<*>)
Link copied to clipboard
fun indexSecondaryTypes(instanceFactory: InstanceFactory<*>)
Link copied to clipboard
operator fun plus(modules: List<Module>): List<Module>
operator fun plus(module: Module): List<Module>

Help write list of Modules

Link copied to clipboard
Link copied to clipboard
inline fun <T> scope(scopeSet: ScopeDSL.() -> Unit)

Class Typed Scope

fun scope(qualifier: Qualifier, scopeSet: ScopeDSL.() -> Unit)

Declare a group a scoped definition with a given scope qualifier

Link copied to clipboard
inline fun <T> single(qualifier: Qualifier? = null, createdAtStart: Boolean = false, noinline definition: Definition<T>): KoinDefinition<T>

Declare a Single definition

Link copied to clipboard
fun <T : Any> Module.single(kClass: KClass<T>, qualifier: Qualifier? = null, definition: Definition<T>, createdAtStart: Boolean = false, scopeQualifier: Qualifier = ScopeRegistry.rootScopeQualifier): KoinDefinition<T>

Create a Single

Link copied to clipboard
inline fun <R> Module.singleOf(crossinline constructor: () -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>

Declare a Module.single definition by resolving a constructor reference for the dependency. The resolution is done at compile time by leveraging inline functions, no reflection is required.

inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1> Module.singleOf(crossinline constructor: (T1) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2> Module.singleOf(crossinline constructor: (T1, T2) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3> Module.singleOf(crossinline constructor: (T1, T2, T3) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4> Module.singleOf(crossinline constructor: (T1, T2, T3, T4) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
inline fun <R, T1, T2, T3, T4, T5, T6, T7, T8, T9> Module.singleOf(crossinline constructor: (T1, T2, T3, T4, T5, T6, T7, T8, T9) -> R, noinline options: DefinitionOptions<R>? = null): KoinDefinition<R>
Generated by Dokka
© 2025 Copyright