rethinkdb / rethinkdb/docs

API JS - r.connect and r.close

Open
#425 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
118
Forks
161
PR merge metrics
No merged PRs in 30d

Description

See http://pastebin.com/GGqiqbKu

We should actually write a whole example on how to connect, bind listeners for errors, run a query, close the connection.

Contributor guide

Open the contributing guide

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.

Research direction

Review the example linked in the issue at pastebin.com/GGqiqbKu and use it to understand the intended JavaScript API flow. Add a documentation example covering connection, error listeners, a query, and closing the connection; done means all four steps are shown together.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.