Reflect Options keys in return types#49
Open
fan-tom wants to merge 1 commit intojackbearheart:masterfrom
Open
Conversation
fan-tom
force-pushed
the
improve_typings
branch
from
d610ea8 to
ad558a5
Compare
Owner
|
This PR makes me wonder if the library should have a major version bump that straightens out the return values. Perhaps instead of the options changing the type of the return value, there should be separate functions. I think that would be simpler both for TS users and non-TS users. It's inconvenient to change type signatures but it would be better in the long run. 🤔 |
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.
Currently return types of functions are very imprecise. For example, if you call
parseFrom({input: myEmail, oneResult: true})it returns one value despite type is still(ParsedMailbox | ParsedGroup)[]. The same issue withsimpleoption. After this PR is merged, that options, if they are statically known to havetruevalue affect return type of all exported functions to correctly reflect return value shape.