matthew-andrews / matthew-andrews/denodeify
Point to `util.promisify` in README?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 225
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Node 8 introduced util.promisify to the standard library, which handles the simple use case of this library.
It also allows functions to opt-in to specifying how they are promisified, which means you can promisify even some non-node-style callback functions (like setTimeout). Can we add a note in the readme stating if they use Node 8, they may want to use it instead?
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
Open the README and find the section describing the library's simple callback-to-promise use case. Add a note that Node 8 users may prefer the standard library's util.promisify, including its support for functions that customize promisification. Done when the README clearly points readers to the Node.js documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100