koin-core/org.koin.dsl

Package-level declarations

Types

KoinAppDeclaration

typealias KoinAppDeclaration = KoinApplication.() -> Unit

KoinConfiguration

class KoinConfiguration(val config: KoinApplication.() -> Unit)

Koin Configuration class holder, intended to replace KoinAppDeclaration that is a typealias on extension function

ModuleDeclaration

typealias ModuleDeclaration = Module.() -> Unit

class ScopeDSL(val scopeQualifier: Qualifier, val module: Module)

DSL Scope Definition

Functions

inline fun <S : Any> KoinDefinition<out S>.bind(): KoinDefinition<out S>

infix fun <S : Any> KoinDefinition<out S>.bind(clazz: KClass<S>): KoinDefinition<out S>

Add a compatible type to match for definition

infix fun KoinDefinition<*>.binds(classes: Array<KClass<*>>): KoinDefinition<*>

Add compatible types to match for definition

fun KoinApplication.includes(vararg configurations: KoinAppDeclaration?): KoinApplication

fun KoinApplication.includes(vararg configurations: KoinConfiguration?): KoinApplication

Includes other KoinConfiguration in the current KoinApplication

koinApplication

fun koinApplication(createEagerInstances: Boolean): KoinApplication

fun koinApplication(appDeclaration: KoinAppDeclaration?): KoinApplication

Create a KoinApplication instance and help configure it. This overload helps ensure backward-compatible bytecode.

fun koinApplication(configuration: KoinConfiguration?): KoinApplication

fun koinApplication(createEagerInstances: Boolean = true, appDeclaration: KoinAppDeclaration? = null): KoinApplication

Create a KoinApplication instance and help configure it

koinConfiguration

fun koinConfiguration(declaration: KoinAppDeclaration): KoinConfiguration

function helper to save a Koin configuration

fun module(createdAtStart: Boolean = false, moduleDeclaration: ModuleDeclaration): Module

Define a Module

infix fun <T> KoinDefinition<T>.onClose(onClose: OnCloseCallback<T>): KoinDefinition<T>

Callback when closing instance

fun <T> KoinDefinition<T>.override(): KoinDefinition<T>

Mark this definition as allowing override, even when global allowOverride is false.