popkorn/cc.popkorn

Package-level declarations

Types

InjectorController

interface InjectorController : InjectorManager

Interface with the available methods to manage injections

InjectorJS

class InjectorJS(injector: InjectorController)

Wrapper for Injector to be used from the JS (pure js)

InjectorJVM

class InjectorJVM(injector: InjectorController)

Wrapper for Injector to be used from the JVM (pure java)

InjectorManager

interface InjectorManager

Interface with the available methods to manage injections

InjectorObjC

class InjectorObjC(injector: InjectorController)

Wrapper for Injector to be used from the ObjectiveC (pure objc)

PopKornCompat

class PopKornCompat

Compatibility class to use PopKorn from java code Use it like PopKornCompat.inject(class)

WeakReference

expect class WeakReference<T : Any>(referred: T)

Methods/Classes used in library that are Platform-dependent

actual typealias WeakReference = WeakReference<T>

actual class WeakReference<T : Any>(referred: T)

actual typealias WeakReference = WeakReference<T>

Implementation for Native of the methods/classes that are Platform-dependent

Functions

inject

inline fun <T : Any> inject(environment: String? = null, noinline config: InjectorConfig.Builder.() -> Unit? = null): T

Methods to inject instances anywhere like inject()

inject

fun <T : Any> KClass<T>.inject(environment: String? = null, config: InjectorConfig.Builder.() -> Unit? = null): T

injecting

inline fun <T : Any> injecting(environment: String? = null, noinline config: InjectorConfig.Builder.() -> Unit? = null): Lazy<T>

injectOrNull

inline fun <T : Any> injectOrNull(environment: String? = null, noinline config: InjectorConfig.Builder.() -> Unit? = null): T?

Methods to inject nullable instances anywhere like injectOrNull()

injectOrNull

fun <T : Any> KClass<T>.injectOrNull(environment: String? = null, config: InjectorConfig.Builder.() -> Unit? = null): T?

normalizeQualifiedName

fun normalizeQualifiedName(path: String): String

popKorn

fun popKorn(): InjectorController

Method to obtain the default injector currently being used

popkorn

inline fun <T : Any> popkorn(environment: String? = null, noinline config: InjectorConfig.Builder.() -> Unit? = null): Lazy<T>

Methods to lazy inject instances anywhere like: val instance by popkorn() val instance by injecting()

setup

fun setup(creator: (ObjCClass) -> Mapping)

This method needs to be called on IOS platform before using PopKorn. This is because from Kotlin cannot instantiate a class with "class_createInstance(ObjCClass, 0) as? Mapping". So we need the ios to provide a lambda of how to create an object

fun setup(resolvers: Set<Mapping>, providers: Set<Mapping>)

Secondary method to initialize popkorn from IOS in case the first doesn't work

fun setup(resolvers: Set<Mapping>, providers: Set<Mapping>)

This method needs to be called on JS platform before using PopKorn. This is because in js cannot automatically locate the mapping files

fun setup(resolvers: Set<Mapping>, providers: Set<Mapping>)

This method needs to be called on Native platform before using PopKorn. This is because in native cannot automatically locate the mapping files

Properties

PROVIDER_MAPPINGS

const val PROVIDER_MAPPINGS: String

PROVIDER_SUFFIX

const val PROVIDER_SUFFIX: String

RESOLVER_MAPPINGS

const val RESOLVER_MAPPINGS: String

RESOLVER_SUFFIX

const val RESOLVER_SUFFIX: String