koin-core/org.koin.core/Koin

Koin

class Koin

Koin

Gather main features to use on Koin context

Author

Arnaud Giuliani

Constructors

constructor()

Properties

extensionManager

val extensionManager: ExtensionManager

instanceRegistry

val instanceRegistry: InstanceRegistry

var logger: Logger

val optionRegistry: OptionRegistry

propertyRegistry

val propertyRegistry: PropertyRegistry

val resolver: CoreResolver

val scopeRegistry: ScopeRegistry

Functions

fun close()

Close all resources from context

createEagerInstances

fun createEagerInstances()

Create Single instances Definitions marked as createdAtStart

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

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

fun deleteProperty(key: String)

Delete a property

fun deleteScope(scopeId: ScopeID)

Delete a scope instance

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

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

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

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

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

Retrieve a property

fun getScope(scopeId: ScopeID): Scope

get a scope instance

fun getScopeOrNull(scopeId: ScopeID): Scope?

get a scope instance

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

Lazy inject a Koin instance

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

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

Load module & create eager instances

fun setProperty(key: String, value: Any)

Save a property

fun setupLogger(logger: Logger)

fun unloadModules(modules: List<Module>)