Class CouchdbService

Apps service

Hierarchy

CouchdbService

Index

Constructors

Properties

httpClient namespace tokenService

Methods

bulkUpdate create delete find getPartitionKey update

Constructors

constructor

new CouchdbService(httpClient, tokenService): CouchdbService
Parameters
- httpClient: HttpClient
- tokenService: TokensService
Returns CouchdbService

Properties

`Private` `Readonly` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/settings-backend/v1'

`Private` `Readonly` tokenService

tokenService: TokensService

Methods

bulkUpdate

bulkUpdate(databaseName, data): Promise<AxiosResponse<ICreateCouchItemResponse[], any>>
Bulk update data from database
Parameters
- databaseName: string
  
  Database name
- data: object[]
  
  Data to update
Returns Promise<AxiosResponse<ICreateCouchItemResponse[], any>>
Array of items

create

create(databaseName, data, type, salt?): Promise<AxiosResponse<ICreateCouchItemResponse, any>>
Create data in database
Parameters
- databaseName: string
  
  Database name
- data: object
  
  Data to create
- type: string
- salt: string = ...
Returns Promise<AxiosResponse<ICreateCouchItemResponse, any>>

delete

delete(databaseName, id, rev): Promise<AxiosResponse<{
    _deleted?: boolean;
    _id?: string;
    _rev?: string;
    type?: string;
}, any>>
Delete data from database
Parameters
- databaseName: string
  
  Database name
- id: string
  
  Document id
- rev: string
  
  Document revision
Returns Promise<AxiosResponse<{
    _deleted?: boolean;
    _id?: string;
    _rev?: string;
    type?: string;
}, any>>

find

find<T>(databaseName, type, id?): Promise<AxiosResponse<ICouchQueryResponse<T>, any>>
Find data from database
Type Parameters
- T = unknown
Parameters
- databaseName: string
  
  Database name
- type: string
  
  non-required param for filtering items by somethings type, for example: tasks, templates, leads and etc
- Optional id: string
Returns Promise<AxiosResponse<ICouchQueryResponse<T>, any>>
Array of items

getPartitionKey

getPartitionKey(type): Promise<string>
Parameters
- type: string
Returns Promise<string>

update

update(databaseName, id, rev, data): Promise<AxiosResponse<ICreateCouchItemResponse, any>>
Update data in database
Parameters
- databaseName: string
  
  Database name
- id: string
  
  Document id
- rev: string
  
  Document revision
- data: object
  
  Data to update
Returns Promise<AxiosResponse<ICreateCouchItemResponse, any>>

Generated using TypeDoc