couchbase / couchbase/docs-sdk-nodejs

bucket.viewQuery should be async in the documentation

Open
#146 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
3
Forks
23
PR merge metrics
No merged PRs in 30d

Description

The docs for querying views shows this :
var result = bucket.viewQuery('beers', 'by_name', { range: { start: 'A' }, limit: 10, })

shouldn't be :
var result = await bucket.viewQuery('beers', 'by_name', { range: { start: 'A' }, limit: 10, })
?

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.

Research direction

Locate the documentation section for querying views and inspect the example using bucket.viewQuery('beers', 'by_name', ...). Update the example to await the call, then verify that the displayed code matches the async usage described in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.