@cbjsdev/http-client

A Couchbase HTTP Client for Node.js & TypeScript.

Documentation | Getting Started | Why Cbjs?

Getting started

To get started with the Couchbase HTTP Client, install the package :

npm install @cbjsdev/http-client

Actions

The Couchbase REST API is vast. This package currently support the following :

Cluster

• initCluster
• setIndexerSettings
• getClusterRelease
• getClusterRootCertificates
• versionSupportsFeatures
• getPool
• getRebalanceProgress

Analytics

• createAnalyticsLink
• getAnalyticsLinks
• getAnalyticsClusterStatus

Eventing

• deployEventingFunction
• pauseEventingFunction
• resumeEventingFunction
• undeployEventingFunction
• dropEventingFunction
• getEventingFunctionStatus
• getEventingFunctions

KeyValue

• getBucket
• getScope
• getCollections

Query

• executeStatement
• getQueryBuckets
• getQueryIndexes
• getQueryIndexRemainingMutations
• getQuerySearchIndexes
• createQueryIndex
• updateQueryIndex

RBAC

• wohami
• updateUserPassword
• getUser
• getUsers
• getUserGroup
• getUserGroups
• getRoles

Search / FTS

• getSearchIndex
• getSearchIndexes
• getSearchIndexStatistics

Stats

• getIndexerStatistics
• getStatistics

Views

• getViewDesignDocuments

WaitFor

This section is dedicated to functions that waits for a resource to reach the expected status.

• waitForBucket
• waitForScope
• waitForCollection
• waitForEventingFunction
• waitForQueryIndexer
• waitForQueryIndex
• waitForSearchIndex
• waitForUser
• waitForUserGroup
• waitForViewDesignDocument
• waitForAnalyticsCluster

License

Apache 2.0 license.