wsmm-couchbase-capacitor-plugin v0.0.114

wsmm-couchbase-capacitor-plugin

Couchbase Capactior Plugin

Install

npm install wsmm-couchbase-capacitor-plugin
npx cap sync

API

• echo(...)
• isDBExists(...)
• close(...)
• query(...)
• deleteDocument(...)
• documentExists(...)
• getDocument(...)
• saveDocument(...)
• addReplicatorChangeListener(...)
• addDocumentListener(...)
• sync(...)
• Interfaces
• Type Aliases

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>

Echo a value

Returns: Promise<{ value: string; }>

isDBExists(...)

isDBExists(options: couchbaseOptions) => Promise<couchbaseResult>

Check if a Couchbase database exists

Returns: Promise<couchbaseResult>

close(...)

close(options: couchbaseOptions) => Promise<void>

Close a Couchbase database

query(...)

query(option: couchbaseQuery) => Promise<couchbaseValues>

Query a Single Statement and closes database after query is complete

Returns: Promise<couchbaseValues>

deleteDocument(...)

deleteDocument(options: couchbaseDocument) => Promise<couchbaseResult>

Delete a single document and closes database after complete

Returns: Promise<couchbaseResult>

documentExists(...)

documentExists(options: couchbaseDocument) => Promise<couchbaseResult>

Checks if document exists in provided database

Returns: Promise<couchbaseResult>

getDocument(...)

getDocument(options: couchbaseDocument) => Promise<couchbaseValues>

Retrieves document by ID from database and closes database after complete

Returns: Promise<couchbaseValues>

saveDocument(...)

saveDocument(options: couchbaseDocument) => Promise<couchbaseResult>

Save a single document and closes database after complete

Returns: Promise<couchbaseResult>

addReplicatorChangeListener(...)

addReplicatorChangeListener(options: couchbaseOptions, cb: PluginCallback) => Promise<PluginListenerHandle>

Add Replicator Change Listener

Returns: Promise<PluginListenerHandle>

addDocumentListener(...)

addDocumentListener(options: couchbaseOptions, cb: PluginCallback) => Promise<PluginListenerHandle>

Add Document Listener

Returns: Promise<PluginListenerHandle>

sync(...)

sync(options: couchbaseOptions) => Promise<void>

Start Sync a Couchbase database

Interfaces

couchbaseResult

couchbaseOptions

couchbaseValues

couchbaseQuery

couchbaseDocument

PluginListenerHandle

PluginResultData

PluginResultError

Type Aliases

PluginCallback

(data: PluginResultData, error?: PluginResultError): void