API - Write operations and how to check for errors
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 118
- Forks
- 161
- PR merge metrics
- No merged PRs in 30d
Description
If someone does a write (like an insert), a few things can happen
- They can get back an error (if a table doesn't exist for example)
- They can get back a result, but with errors > 0
We should write a full example on how to check if the write made it through.
Things also get quite tricky with promises if you want to merge branches.
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
No files, tests, or entry points are named. Locate the existing documentation for write operations and promises, then define a complete example covering direct errors, results with errors, and merging promise branches. Done means the example explains how to verify that a write succeeded.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100