Add a resolution extension to extend Koin's dependency resolution capabilities. Extensions allow Koin to resolve dependencies from external DI systems (e.g., Ktor DI).

fun close()

Close all resources from context

createEagerInstances

fun createEagerInstances()

Create Single instances Definitions marked as createdAtStart

createScope

fun <T : KoinScopeComponent> createScope(t: T): Scope

inline fun <T : Any> createScope(scopeId: ScopeID = KoinPlatformTools.generateId()): Scope

inline fun <T : Any> createScope(scopeId: ScopeID, source: Any? = null, scopeArchetype: TypeQualifier? = null): Scope

fun createScope(scopeId: ScopeID, qualifier: Qualifier, source: Any? = null, scopeArchetype: TypeQualifier? = null): Scope

Create a Scope instance

declare

inline fun <T> declare(instance: T, qualifier: Qualifier? = null, secondaryTypes: List<KClass<*>> = emptyList(), allowOverride: Boolean = true)

Declare a component definition from the given instance This result of declaring a single definition of type T, returning the given instance

deleteProperty

fun deleteProperty(key: String)

Delete a property

deleteScope

fun deleteScope(scopeId: ScopeID)

Delete a scope instance

get

inline fun <T : Any> get(qualifier: Qualifier? = null, noinline parameters: ParametersDefinition? = null): T

fun <T> get(clazz: KClass<*>, qualifier: Qualifier? = null, parameters: ParametersDefinition? = null): T

Get a Koin instance

getAll

inline fun <T> getAll(): List<T>

Get a all instance for given inferred class (in primary or secondary type)

getOrCreateScope

inline fun <T : Any> getOrCreateScope(scopeId: ScopeID): Scope

fun getOrCreateScope(scopeId: ScopeID, qualifier: Qualifier, source: Any? = null): Scope

Get or Create a Scope instance

getOrNull

inline fun <T : Any> getOrNull(qualifier: Qualifier? = null, noinline parameters: ParametersDefinition? = null): T?

fun <T> getOrNull(clazz: KClass<*>, qualifier: Qualifier? = null, parameters: ParametersDefinition? = null): T?

Get a Koin instance if available

getProperty

fun <T : Any> getProperty(key: String): T?

fun <T : Any> getProperty(key: String, defaultValue: T): T

Retrieve a property

getScope

fun getScope(scopeId: ScopeID): Scope

get a scope instance

getScopeOrNull

fun getScopeOrNull(scopeId: ScopeID): Scope?

get a scope instance

inject

inline fun <T : Any> inject(qualifier: Qualifier? = null, mode: LazyThreadSafetyMode = KoinPlatformTools.defaultLazyMode(), noinline parameters: ParametersDefinition? = null): Lazy<T>

Lazy inject a Koin instance

injectOrNull

inline fun <T : Any> injectOrNull(qualifier: Qualifier? = null, mode: LazyThreadSafetyMode = KoinPlatformTools.defaultLazyMode(), noinline parameters: ParametersDefinition? = null): Lazy<T?>

Lazy inject a Koin instance if available

loadModules

fun loadModules(modules: List<Module>, allowOverride: Boolean = true, createEagerInstances: Boolean = false)

Load module & create eager instances

setProperty

fun setProperty(key: String, value: Any)

Save a property

setupLogger

fun setupLogger(logger: Logger)

unloadModules

fun unloadModules(modules: List<Module>)