Promise-based `write` API?
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 321
- Forks
- 195
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/mapbox/shp-write/blob/48a0fe72c09f74f6256ac8d4177af272d01317c3/src/write.js#L15-L16
While updating the README, I realized that `write` does not use async/await. This seems ancient. This issue tracks the upgrade of this (unless the current callback form is in fact better for some reason)
Contributor guide
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 src/write.js at lines 15-16 and compare the current callback contract with the README usage. Determine whether a promise-based write API should replace or complement the callback form; done means the chosen API behavior is implemented and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100