mafintosh / mafintosh/multi-read-stream
No validation of streams
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 22
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
I recently hit a bug that was kinda hard to debug where I was accidentally passing a stream constructor rather than a stream to multi-read-stream. The error came from fairly deep inside pump.
Would you be open to a PR implementing simple validation of the input arguments using is-stream, and throwing a helpful error if any of the args isn't a stream?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the input-argument handling and the path into pump in multi-read-stream; the issue provides no file or test names. Verify the behavior with stream instances and invalid arguments such as a stream constructor, then ensure invalid inputs produce a helpful error rather than failing deep inside pump.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- backend
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100