fix(unzip): fix Yauzl typings #12
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
Both `open` and `openReadStream` have overloads, so `promisify` can't know which one to choose and chooses the last one (which doesn't include options). Additionally, once we specify those two overloads, optional args become `arg | undefined` which is subtly different than not providing an arg (which is what we want to be able to do), so we specify onEntry's `openReadStream` callback explicitly as well (to have options be optional). I think this last point is also why we can't just update `yauzl`'s types to have both `options` and `callback` be optional, because `options` when `promisified` will be unioned with `undefined`, not optional (meaning you can't just leave it off, you'd have to actually pass `undefined` as the value if you want to use it). microsoft/TypeScript#13570 microsoft/TypeScript#13195
imhoffd
reviewed
Feb 7, 2019
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.
Both
openandopenReadStreamhave overloads, sopromisifycan't know which one to choose and chooses the last one (which
doesn't include options). Additionally, once we specify those two
overloads, optional args become
arg | undefinedwhich is subtlydifferent than not providing an arg (which is what we want to be
able to do), so we specify onEntry's
openReadStreamcallbackexplicitly as well (to have options be optional).
I think this last point is also why we can't just update
yauzl'stypes to have both
optionsandcallbackbe optional, becauseoptionswhenpromisifiedwill be unioned withundefined, notoptional (meaning you can't just leave it off, you'd have to
actually pass
undefinedas the value if you want to use it).microsoft/TypeScript#13570
microsoft/TypeScript#13195