NodeJS API Reference?


#1

Hi, I’ve been looking for the NodeJS couchbase API reference for a while now but I can not find it. All the links seem to end up on the “getting started”/“guide” page. Is there an online API reference for the NodeJS SDK?

This is what I’ve found so far:

couchbase.com
->
developer.couchbase.com (Developer portal top drop down link)
->
(Guide and references - SDKs dropdown menu) developer.couchbase.com/guides-and-references#sdks-anchor
->
(NODEJS SDK 2.0/2.1 - Download and API reference) developer.couchbase.com/documentation/server/4.1/sdks/node-2.0/download-links.html.

The “current” API Reference link seems to be broken and redirect to a non-nodejs related doc archive page. Older versions link to a page docs.couchbase.com/sdk-api/couchbase-node-client-2.1.3/ for example. However, this page have no API reference and links to the following two pages: couchbase.com (I’ve already been there…) and to developer.couchbase.com/open-source-projects. From the open source projects page I can expand the NodeJS link and navigate via the link “Documentation” to the page developer.couchbase.com/documentation/server/current/sdks/node-2.0/introduction.html. But this page only leads back to the “Download and API reference” page which I’ve already visited before.

Surely I must have missed a link somewhere :).

Regards
Mikael


#2

From the download and install page I was able to get to the 2.1.3 API reference, but the 2.1.4 link is indeed broken.

I’ve created JSCBC-288 to track this. Thanks for reporting the issue.


#3

Hi, can you please make it a priority to fix this? Still a problem with the 2.5 SDK documentaiton. I’m on the page: http://docs.couchbase.com/sdk-api/couchbase-node-client-2.5.0/

There is basically no API spec or reference. The link titled “Node.js Community” is listed under the “Documentation” section, but it doesn’t go to it.

Is there any other way to find it anywhere right now?


#4

Hey @twinkle,

Could you elaborate on what exactly you are looking for? You can find our API reference at the link you posted, there is a navigation bar along the top to navigate to information about specific pieces of the SDK, for instance:
http://docs.couchbase.com/sdk-api/couchbase-node-client-2.5.0/Bucket.html

You can find the high-level documentation of our SDKs on our developer website here:
https://developer.couchbase.com/documentation/server/5.5/sdk/nodejs/start-using-sdk.html

Cheers, Brett