Request for documentation on how node-redis handles connections on non-graceful disconnects
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 17.6k
- Forks
- 2k
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 40
Description
Issue
I was unable to find documentation on the importance of the client needing to call client.quit/client.end before disconnecting, or any such warning thereof (which leads me to assume that the connection automatically disconnects after some time). If you forget to call client.quit or your server unexpectedly crashes, will the redis client automatically disconnect after some time? or will you have leaked connections and you'll finally hit the rate limit? Either way I think a sentence or two on this in the docs will largely clarify the matter.
Thank you.
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 documentation file or test is named. Start by locating the documentation for client.quit and client.end, then confirm how node-redis handles unexpected disconnects and whether connections expire; done when the relevant guidance is clearly documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js, redis, typescript
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100