Please add documentation about DatabaseError

Open Beginner friendly
#3,770 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
javascript, postgresql
Domain
databases, documentation

Research direction

Start with the error-handling documentation at https://node-postgres.com/#error-handling and inspect how DatabaseError is exposed by the API. Document DatabaseError and its fields so users can interpret API errors, then verify that the updated error-handling documentation is clear and complete.

Written by the indexing model from the issue text.

Description

Maybe I missed something . But I had hard time to interpret error from the API. I think Documentation should at least mention DatabaseError and better, document fields into this error. The only documentation about error handling is here https://node-postgres.com/#error-handling This is a bit short.

Dominant language
JavaScript
Stars
13.2k
Forks
1.4k
Avg merge
6d 15h
Merged PRs (30d)
6

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from brianc/node-postgres

All issues in brianc/node-postgres

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.