commonMain.org.koin.dsl.KoinApplication.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of koin-core Show documentation

KOIN - Kotlin simple Dependency Injection Framework

There is a newer version: 4.0.0

/*
 * Copyright 2017-Present the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.koin.dsl

import org.koin.core.KoinApplication
import org.koin.core.module.KoinApplicationDslMarker

typealias KoinAppDeclaration = KoinApplication.() -> Unit

/**
 * Create a KoinApplication instance and help configure it
 * @author Arnaud Giuliani
 *
 * @param createEagerInstances allow to create eager instances or not
 * @param appDeclaration closure for configuration of a new Koin context
 */
@KoinApplicationDslMarker
fun koinApplication(createEagerInstances: Boolean = true, appDeclaration: KoinAppDeclaration? = null): KoinApplication {
    val koinApplication = KoinApplication.init()
    appDeclaration?.invoke(koinApplication)
    if (createEagerInstances) {
        koinApplication.createEagerInstances()
    }
    return koinApplication
}

/**
 * Create a KoinApplication instance and help configure it.
 * This overload helps ensure backward-compatible bytecode.
 *
 * @param appDeclaration closure for configuration of a new Koin context
 * @author Gary Spreder
 */
@KoinApplicationDslMarker
fun koinApplication(appDeclaration: KoinAppDeclaration?): KoinApplication {
    return koinApplication(createEagerInstances = true, appDeclaration = appDeclaration)
}

/**
 * Create a KoinApplication instance and help configure it.
 * This overload helps ensure backward-compatible bytecode.
 *
 * @param createEagerInstances allow to create eager instances or not
 * @author Gary Spreder
 */
@KoinApplicationDslMarker
fun koinApplication(createEagerInstances: Boolean): KoinApplication {
    return koinApplication(createEagerInstances = createEagerInstances, appDeclaration = null)
}