JsCommunity / JsCommunity/async-iterator-to-stream
Relation with Node 12.3 `Readable.from`
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 7
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
It was added in node v12.3: https://nodejs.org/api/stream.html#stream_stream_readable_from_iterable_options.
I've used this library, but I just discovered that node now has a helper to do the same thing. It seems the only major difference is that you can't pass a generator function directly.
I think it'd be helpful to add a note to the readme to point people to the built-in solution, and explain the differences so that people can decide which to use.
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 with the README and compare the library's documented behavior with Node 12.3's Readable.from documentation at the linked stream URL. Document the built-in alternative, including the difference around passing a generator function directly, so readers can choose between the two approaches.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100