Skip to content

Commit

Permalink
docs: Update types and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Ldoppea committed Sep 19, 2024
1 parent c7ed369 commit 09c2314
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
16 changes: 8 additions & 8 deletions docs/api/cozy-pouch-link/classes/PouchLink.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ CozyLink.constructor

*Defined in*

[CozyPouchLink.js:688](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L688)
[CozyPouchLink.js:689](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L689)

***

Expand All @@ -152,7 +152,7 @@ CozyLink.constructor

*Defined in*

[CozyPouchLink.js:649](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L649)
[CozyPouchLink.js:650](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L650)

***

Expand Down Expand Up @@ -199,7 +199,7 @@ Create the PouchDB index if not existing

*Defined in*

[CozyPouchLink.js:692](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L692)
[CozyPouchLink.js:693](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L693)

***

Expand All @@ -219,7 +219,7 @@ Create the PouchDB index if not existing

*Defined in*

[CozyPouchLink.js:677](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L677)
[CozyPouchLink.js:678](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L678)

***

Expand All @@ -241,7 +241,7 @@ Create the PouchDB index if not existing

*Defined in*

[CozyPouchLink.js:619](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L619)
[CozyPouchLink.js:620](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L620)

***

Expand Down Expand Up @@ -697,7 +697,7 @@ Emits pouchlink:sync:stop event

*Defined in*

[CozyPouchLink.js:714](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L714)
[CozyPouchLink.js:715](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L715)

***

Expand All @@ -717,7 +717,7 @@ Emits pouchlink:sync:stop event

*Defined in*

[CozyPouchLink.js:654](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L654)
[CozyPouchLink.js:655](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L655)

***

Expand All @@ -737,7 +737,7 @@ Emits pouchlink:sync:stop event

*Defined in*

[CozyPouchLink.js:659](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L659)
[CozyPouchLink.js:660](https://github.com/cozy/cozy-client/blob/master/packages/cozy-pouch-link/src/CozyPouchLink.js#L660)

***

Expand Down
3 changes: 2 additions & 1 deletion packages/cozy-pouch-link/types/helpers.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ declare namespace helpers {
function isDesignDocument(doc: any): boolean;
function isDeletedDocument(doc: any): any;
function insertBulkDocs(db: any, docs: any): Promise<any>;
function normalizeFindSelector({ selector, sort, indexedFields }: {
function normalizeFindSelector({ selector, sort, indexedFields, partialFilter }: {
selector: any;
sort: any;
indexedFields: any;
partialFilter: any;
}): any;
}

0 comments on commit 09c2314

Please sign in to comment.