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

| Param | Type | | ------------- | ------------------------------- | | options | { value: string; } |

Returns: Promise<{ value: string; }>

isDBExists(...)

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

Check if a Couchbase database exists

| Param | Type | Description | | ------------- | ------------------------------------------------------------- | -------------------------------------------------- | | options | couchbaseOptions | : couchbaseOptions |

Returns: Promise<couchbaseResult>

close(...)

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

Close a Couchbase database

| Param | Type | Description | | ------------- | ------------------------------------------------------------- | -------------------------------------------------- | | options | couchbaseOptions | : couchbaseOptions |

query(...)

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

Query a Single Statement and closes database after query is complete

| Param | Type | | ------------ | --------------------------------------------------------- | | option | couchbaseQuery |

Returns: Promise<couchbaseValues>

deleteDocument(...)

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

Delete a single document and closes database after complete

| Param | Type | Description | | ------------- | --------------------------------------------------------------- | ---------------------------------------------------- | | options | couchbaseDocument | : couchbaseDocument |

Returns: Promise<couchbaseResult>

documentExists(...)

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

Checks if document exists in provided database

| Param | Type | Description | | ------------- | --------------------------------------------------------------- | ---------------------------------------------------- | | options | couchbaseDocument | : couchbaseDocument |

Returns: Promise<couchbaseResult>

getDocument(...)

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

Retrieves document by ID from database and closes database after complete

| Param | Type | Description | | ------------- | --------------------------------------------------------------- | ---------------------------------------------------- | | options | couchbaseDocument | : couchbaseDocument |

Returns: Promise<couchbaseValues>

saveDocument(...)

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

Save a single document and closes database after complete

| Param | Type | Description | | ------------- | --------------------------------------------------------------- | ---------------------------------------------------- | | options | couchbaseDocument | : couchbaseDocument |

Returns: Promise<couchbaseResult>

addReplicatorChangeListener(...)

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

Add Replicator Change Listener

| Param | Type | Description | | ------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | | options | couchbaseOptions | : couchbaseOptions, PluginCallback | | cb | PluginCallback | |

Returns: Promise<PluginListenerHandle>

addDocumentListener(...)

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

Add Document Listener

| Param | Type | Description | | ------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | | options | couchbaseOptions | : couchbaseOptions, PluginCallback | | cb | PluginCallback | |

Returns: Promise<PluginListenerHandle>

sync(...)

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

Start Sync a Couchbase database

| Param | Type | Description | | ------------- | ------------------------------------------------------------- | -------------------------------------------------- | | options | couchbaseOptions | : couchbaseOptions |

Interfaces

couchbaseResult

| Prop | Type | Description | | ------------ | -------------------- | --------------------------------------------- | | result | boolean | result set to true when successful else false |

couchbaseOptions

| Prop | Type | Description | | ------------- | ------------------- | ----------------- | | appName | string | The database name |

couchbaseValues

| Prop | Type | Description | | ------------ | ------------------ | ---------------------------------------------------------------------------------------- | | values | any[] | the data values list as an Array iOS the first row is the returned ios_columns name list |

couchbaseQuery

| Prop | Type | Description | | ------------- | ------------------- | ------------- | | appName | string | Database name | | query | string | Query string |

couchbaseDocument

| Prop | Type | Description | | ------------- | ------------------- | ---------------------------- | | appName | string | Database name | | id | string | Query document ID | | value | string | Stringified JSON of document |

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

PluginResultData

PluginResultError

| Prop | Type | | ------------- | ------------------- | | message | string |

Type Aliases

PluginCallback

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