2.8.5 • Published 4 years ago

capacitor-cblite v2.8.5

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

capacitor-cblite

Add native CBLite support to Capacitor apps

Install

npm install capacitor-cblite
npx cap sync

API

open(...)

open(options: CallOptions) => any
ParamType
optionsCallOptions

Returns: any


close(...)

close(options: CallOptions) => any
ParamType
optionsCallOptions

Returns: any


sync(...)

sync(options: ReplicationOptions) => any
ParamType
optionsReplicationOptions

Returns: any


updateSessionID(...)

updateSessionID(options: any) => any
ParamType
optionsany

Returns: any


stopSync(...)

stopSync(options: CallOptions) => any
ParamType
optionsCallOptions

Returns: any


destroy(...)

destroy(options: CallOptions) => any
ParamType
optionsCallOptions

Returns: any


get(...)

get<T>(options: CallOptions & DatabaseRecord) => any
ParamType
optionsCallOptions & DatabaseRecord

Returns: any


put(...)

put<T>(options: CallOptions & { doc: DatabaseRecord & T; }) => any
ParamType
optionsCallOptions & { doc: DatabaseRecord & T; }

Returns: any


remove(...)

remove(options: CallOptions & DatabaseRecord) => any
ParamType
optionsCallOptions & DatabaseRecord

Returns: any


indexes(...)

indexes(options: CallOptions) => any
ParamType
optionsCallOptions

Returns: any


createIndex(...)

createIndex(options: CallOptions & { index: IndexRequest; }) => any
ParamType
optionsCallOptions & { index: IndexRequest; }

Returns: any


registerScript(...)

registerScript(options: { label: string; script: string; }) => any
ParamType
options{ label: string; script: string; }

Returns: any


query(...)

query<T = unknown>(options: CallOptions & QueryOptions<T>) => any
ParamType
optionsCallOptions & QueryOptions<T>

Returns: any


addListener(...)

addListener(event: 'cblite:repl', listener: (data: ReplEvent) => void) => any
ParamType
event"cblite:repl"
listener(data: ReplEvent) => void

Returns: any


addListener(...)

addListener(event: 'cblite:change', listener: (data: ChangeEvent) => void) => any
ParamType
event"cblite:change"
listener(data: ChangeEvent) => void

Returns: any


Interfaces

CallOptions

PropType
namestring

ReplicationOptions

PropType
hoststring
sessionIdstring

DatabaseRecord

PropType
_idstring
_revstring

IndexRequest

PropType
fields{}
namestring

IndexResult

PropType
result"created" | "exists"
namestring

QueryOptions

PropType
querystring | Query
callbackstring | Callback<T>

Query

PropType
what{}
where{}
group_by{}
order_by{}
limitnumber
offsetnumber

QueryResult

PropType
rows{}
executionTimenumber
totalTimenumber
totalCountnumber
finalCountnumber

ReplEvent

PropType
namestring
completednumber
totalnumber
errorstring
statusnumber
eventstring

ChangeEvent

PropType
namestring
docany