Options
All
  • Public
  • Public/Protected
  • All
Menu

couchbase

Index

Core

Key-Value

Query

Views

Full Text Search

Analytics

Datastructures

Management

Diagnostics

Authentication

Error Handling

Logging

Other

Utilities

Core

connect

  • Acts as the entrypoint into the rest of the library. Connecting to the cluster and exposing the various services and features.

    Parameters

    • connStr: string

      The connection string to use to connect to the cluster.

    • Optional options: ConnectOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<Cluster>

      A node-style callback to be invoked after execution.

    Returns Promise<Cluster>

Key-Value

Cas

Cas: any

CAS represents an opaque value which can be used to compare documents to determine if a change has occurred.

Full Text Search

GeoPoint

GeoPoint: [longitude: number, latitude: number] | { lat: number; lon: number } | { latitude: number; longitude: number }

GeoPoint represents a specific coordinate on earth. We support a number of different variants of geopoints being specified.

Authentication

Authenticator

Authenticator: IPasswordAuthenticator | ICertificateAuthenticator

Represents any of the valid authenticators that could be passed to the SDK.

Logging

defaultLogger

  • The default logger which is used by the SDK. This logger uses the debug library to write its log messages in a way that is easily accessible.

    Parameters

    Returns void

Other

Const lcbVersion

lcbVersion: string = binding.lcbVersion

Exposes the underlying libcouchbase library version that is being used by the SDK to perform I/O with the cluster.

Generated using TypeDoc