fix: enforce strict generic return type for get() method#45
Merged
tduyng merged 1 commit intoJul 10, 2026
Merged
Conversation
tduyng
reviewed
Jul 6, 2026
tduyng
reviewed
Jul 6, 2026
aurelienbouteiller-ekino
force-pushed
the
fix-get-method-types
branch
from
f8b43df to
9cb9fb7
Compare
Contributor
|
The linter is failed! |
aurelienbouteiller-ekino
force-pushed
the
fix-get-method-types
branch
from
9cb9fb7 to
437b75b
Compare
Author
Fixed! |
Contributor
LGTM. I'll merge this PR and make a new release. Thank you @aurelienbouteiller-ekino |
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
2 participants
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.
What does this PR do?
This PR fixes an issue where config.get() was unnecessarily returning T | unknown instead of strictly returning the provided generic type T. This union type forced developers to manually cast types, bypassing the main benefit of the generic parameter.
Changes:
Updated src/index.ts so get() defaults its generic to unknown and strictly returns T.
Added function overloads to getValue() in src/utils/index.ts. It now explicitly returns T when the path argument is a string, while keeping T | undefined for array/undefined paths.
Added compile-time unit tests in test/index.test.ts using vitest's expectTypeOf to assert that config.get properly maps to the expected strict type without falling back to unknown.
Related Issue: Closes #44