Fix the .get() TypeScript return type
#117
Merged
Conversation
This file contains 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
sindresorhus
changed the title
.get() TypeScript return type
sneljo1
reviewed
Aug 11, 2020
| expectType<string | undefined>(conf.get('foo')); | ||
| expectType<string>(conf.get('foo')); |
There was a problem hiding this comment.
The second one was indeed incorrect. But Is it correct to assume that a value will never be undefined when we do not pass a default? I think we should still make it possible to be undefined to encourage people to handle an undefined state.
There was a problem hiding this comment.
Yes, value will never be undefined unless developer make a bug such in this test, type UnicornFoo is source of truth.
type UnicornFoo = {
foo: string;
};
const conf = new Conf<UnicornFoo>({accessPropertiesByDotNotation: true});Maybe we should validate default option, but it is out of scope of this PR.
Like this
defaults?: Readonly<{
[P in keyof T]: Exclude<T[P], undefined>
}>;
There was a problem hiding this comment.
Maybe we should validate default option, but it is out of scope of this PR.
That would be nice, yes, but I agree, it should be a separate PR.
|
Thanks for fixing this, @SnosMe 🙌🏻 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #116