Add koinGet() composable and deprecate koinInject() for naming consistency#2423
Open
saadkhalidkhan wants to merge 1 commit into
Open
Add koinGet() composable and deprecate koinInject() for naming consistency#2423saadkhalidkhan wants to merge 1 commit into
saadkhalidkhan wants to merge 1 commit into
Conversation
…tency koinInject() uses Scope.get() (eager resolution) under the hood, but the name implies lazy resolution like Scope.inject(). This adds koinGet() as the correctly-named alternative and deprecates koinInject() with a ReplaceWith migration. Fixes InsertKoinIOgh-2405
saadkhalidkhan
force-pushed
the
fix/koin-get-naming-2405
branch
from
262b8b9 to
e284f2f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
koinGet()composable functions as the correctly-named alternative tokoinInject()koinInject()with@Deprecated+ReplaceWithfor easy IDE migrationkoinGet()Rationale
In Koin core:
KoinComponent.get()/Scope.get()= eager resolution, returnsTKoinComponent.inject()/Scope.inject()= lazy resolution, returnsLazy<T>In Compose,
koinInject()callsScope.get()(eager) but the name suggests lazy resolution.koinGet()aligns the Compose API naming with core Koin conventions.Fixes #2405
Test plan
koinGet()functions mirror all three overloads ofkoinInject()koinInject()delegates tokoinGet()(no behavior change):compose:koin-compose:compileDebugKotlinAndroidsuccessfullykoinGet()