Tiny doc improvement: Clarify that required parameters are paths #56
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
Because yauzl is able to read from buffers and file descriptors, it is not clear what `source` means. I fell into that trap and tried to feed it a Buffer, just to receive this not-so-obvious error:
{ Error: Path must be a string without null bytes
at nullCheck (fs.js:117:14)
at Object.fs.open (fs.js:543:8)
at Object.open (/Users/xeli/Build/tresdb/node_modules/yauzl/index.js:28:6)
at openZip (/Users/xeli/Build/tresdb/node_modules/extract-zip/index.js:30:11)
at /Users/xeli/Build/tresdb/node_modules/extract-zip/index.js:23:7
at LOOP (fs.js:1611:14)
at _combinedTickCallback (internal/process/next_tick.js:67:7)
at process._tickCallback (internal/process/next_tick.js:98:9) code: 'ENOENT' }
Therefore, here I propose that `source` is changed to `sourcePath` and `target` to `targetPath` to protect others from this trap.
Oliboy50
approved these changes
Aug 22, 2018
|
Seems like this was overwritten by 7993cb8#diff-5a831ea67cf5cf8703b0de46901ab25bd191f56b320053be9332d9a3b0d01d15 - I was just now reading the README for the first time and I was also wondering what |
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.
Because yauzl is able to read from buffers and file descriptors, it is not clear what
sourcemeans in extract-zip. I fell into that trap and tried to feed it a Buffer, just to receive this not-so-obvious error:Therefore, here I propose that readme.md is improved so that
sourceis changed tosourcePathandtargettotargetPathto protect others from this trap.