

cozy-pouch-link / PouchLink

Class: PouchLink

Link to be passed to a CozyClient instance to support CouchDB. It instantiates PouchDB collections for each doctype that it supports and knows how to respond to queries and mutations.

Hierarchy

• default

  ↳ PouchLink

Constructors

constructor

• new PouchLink(opts)

constructor - Initializes a new PouchLink

Parameters

Name	Type
opts	PouchLinkOptions

Overrides

CozyLink.constructor

Defined in

CozyPouchLink.js:89

Properties

client

• client: any

Defined in

CozyPouchLink.js:149

---

doctypes

• doctypes: string[]

Defined in

CozyPouchLink.js:104

---

doctypesReplicationOptions

• doctypesReplicationOptions: Record<string, any>

Defined in

CozyPouchLink.js:105

---

indexes

• indexes: Object

Defined in

CozyPouchLink.js:106

---

initialSync

• initialSync: boolean

Defined in

CozyPouchLink.js:110

---

options

• options: { replicationInterval: number } & PouchLinkOptions

Defined in

CozyPouchLink.js:98

---

periodicSync

• periodicSync: boolean

Defined in

CozyPouchLink.js:111

---

pouches

• pouches: any

Defined in

CozyPouchLink.js:219

---

replicationStatus

• replicationStatus: Record<string, ReplicationStatus>

Defined in

CozyPouchLink.js:114

---

storage

• storage: PouchLocalStorage

Defined in

CozyPouchLink.js:107

Methods

addReferencesTo

▸ addReferencesTo(mutation): Promise<void>

Parameters

Name	Type
mutation	any

Returns

Promise<void>

Defined in

CozyPouchLink.js:746

---

createDocument

▸ createDocument(mutation): Promise<any>

Parameters

Name	Type
mutation	any

Returns

Promise<any>

Defined in

CozyPouchLink.js:707

---

createIndex

▸ createIndex(fields, indexOption?): Promise<PouchDbIndex>

Create the PouchDB index if not existing

Parameters

Name	Type	Description
fields	any[]	Fields to index
indexOption	Object	Options for the index
indexOption.doctype	string	-
indexOption.indexName	string	-
indexOption.partialFilter	any	-

Returns

Promise<PouchDbIndex>

Defined in

CozyPouchLink.js:538

---

dbMethod

▸ dbMethod(method, mutation): Promise<any>

Parameters

Name	Type
method	any
mutation	any

Returns

Promise<any>

Defined in

CozyPouchLink.js:750

---

deleteDocument

▸ deleteDocument(mutation): Promise<any>

Parameters

Name	Type
mutation	any

Returns

Promise<any>

Defined in

CozyPouchLink.js:735

---

executeMutation

▸ executeMutation(mutation, result, forward): Promise<any>

Parameters

Name	Type
mutation	any
result	any
forward	any

Returns

Promise<any>

Defined in

CozyPouchLink.js:677

---

executeQuery

▸ executeQuery(__namedParameters): Promise<{ data: any = res.cozyPouchData; meta: undefined ; next: undefined ; skip: undefined = offset } | { data: any ; meta: { count: any = docs.length } ; next: boolean ; skip: any = offset }>

Parameters

Name	Type
__namedParameters	Object

Returns

Promise<{ data: any = res.cozyPouchData; meta: undefined ; next: undefined ; skip: undefined = offset } | { data: any ; meta: { count: any = docs.length } ; next: boolean ; skip: any = offset }>

Defined in

CozyPouchLink.js:615

---

findExistingIndex

▸ findExistingIndex(doctype, options, indexName): PouchDbIndex

Retrieve the PouchDB index if exist, undefined otherwise

Parameters

Name	Type	Description
doctype	string	The query’s doctype
options	MangoQueryOptions	The find options
indexName	string	The index name

Returns

PouchDbIndex

Defined in

CozyPouchLink.js:562

---

getChanges

▸ getChanges(doctype, options): Promise<PouchDBChangesResults>

Get PouchDB changes See https://pouchdb.com/api.html#changes

Parameters

Name	Type	Description
doctype	string	The PouchDB database’s doctype
options	any	The changes options. See https://pouchdb.com/api.html#changes

Returns

Promise<PouchDBChangesResults>

The changes

Defined in

CozyPouchLink.js:415

---

getDbInfo

▸ getDbInfo(doctype): Promise<PouchDBInfo>

Get PouchDB database info See https://pouchdb.com/api.html#database_information

Parameters

Name	Type	Description
doctype	string	The PouchDB database’s doctype

Returns

Promise<PouchDBInfo>

The db info

Defined in

CozyPouchLink.js:430

---

getPouch

▸ getPouch(doctype): any

Parameters

Name	Type
doctype	any

Returns

any

Defined in

CozyPouchLink.js:340

---

getReplicationURL

▸ getReplicationURL(doctype): string

Parameters

Name	Type
doctype	any

Returns

string

Defined in

CozyPouchLink.js:129

---

getSyncInfo

▸ getSyncInfo(doctype): any

Parameters

Name	Type
doctype	any

Returns

any

Defined in

CozyPouchLink.js:336

---

handleDoctypeSyncEnd

▸ handleDoctypeSyncEnd(doctype): void

Parameters

Name	Type
doctype	any

Returns

void

Defined in

CozyPouchLink.js:273

---

handleDoctypeSyncStart

▸ handleDoctypeSyncStart(doctype): void

Parameters

Name	Type
doctype	any

Returns

void

Defined in

CozyPouchLink.js:268

---

handleOnSync

▸ handleOnSync(doctypeUpdates): void

Receives PouchDB updates (documents grouped by doctype). Normalizes the data (.id -> ._id, .rev -> _rev). Passes the data to the client and to the onSync handler.

Emits an event (pouchlink:sync:end) when the sync (all doctypes) is done

Parameters

Name	Type
doctypeUpdates	any

Returns

void

Defined in

CozyPouchLink.js:254

---

hasIndex

▸ hasIndex(name): boolean

Parameters

Name	Type
name	any

Returns

boolean

Defined in

CozyPouchLink.js:524

---

migrateAdapter

▸ migrateAdapter(params): Promise<void>

Migrate the current adapter

property {string} [fromAdapter] - The current adapter type, e.g. ‘idb’

property {string} [toAdapter] - The new adapter type, e.g. ‘indexeddb’

property {string} [url] - The Cozy URL

property {Array