Utilities

A few utilities are exposed to help you in your daily development.

keyspacePath

Create a path to the given keyspace, while surrounding each segment with backticks.

import { keyspacePath } from '@cbjsdev/cbjs';

const path = keyspacePath('store', 'library');
const path2 = keyspacePath({ bucket: 'store', scope: 'library' }); 

// => `store`.`library`

quotePath

Use this when one of the property name is a reserved word.

import { quotePath } from '@cbjsdev/cbjs';

const subDocPath = quotePath('root.scope.groupId'); // `root`.`scope`.`groupId`

CouchbaseCas

The class CouchbaseCas can be used to convert a CAS representation to another or to compare two CAS.

CouchbaseCas.from

Create a new instance from the given value.

const cas = CouchbaseCas.from(0);

CouchbaseCas.toString

Returns a string representation of the CAS.
You can use this function to send a CAS a part of a JSON object for example.

const { content, cas } = await collection.insert(
  'book::001', 
  { title: 'Couchbase SDK for Node.js & TypeScript' }
);
return CouchbaseCas.toString(cas);

CouchbaseCas.isZeroCas

Returns true if the CAS representation can be translated to 0.

if (CouchbaseCas.isZeroCas(cas)) {
    // some logic
}

CouchbaseCas.isEqual

Returns true if two CAS represent the same value.

if (CouchbaseCas.isEqual(stringCas, bufferCas)) {
    // some logic
}