docs: Update types and documentation

cozy · Jul 22, 2024 · b8abde2 · b8abde2
1 parent 11c2d88
commit b8abde2
Show file tree

Hide file tree

Showing 9 changed files with 320 additions and 147 deletions.
diff --git a/docs/api/cozy-client/classes/CozyClient.md b/docs/api/cozy-client/classes/CozyClient.md
diff --git a/docs/api/cozy-client/classes/CozyLink.md b/docs/api/cozy-client/classes/CozyLink.md
@@ -12,20 +12,43 @@
 
 ### constructor
 
-• **new CozyLink**(`requestHandler`)
+• **new CozyLink**(`requestHandler`, `persistHandler`)
 
 *Parameters*
 
 | Name | Type |
 | :------ | :------ |
 | `requestHandler` | `any` |
+| `persistHandler` | `any` |
 
 *Defined in*
 
 [packages/cozy-client/src/CozyLink.js:2](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L2)
 
 ## Methods
 
+### persistData
+
+▸ **persistData**(`definition`, `data`, `forward`): `void`
+
+*Parameters*
+
+| Name | Type |
+| :------ | :------ |
+| `definition` | `any` |
+| `data` | `any` |
+| `forward` | `any` |
+
+*Returns*
+
+`void`
+
+*Defined in*
+
+[packages/cozy-client/src/CozyLink.js:16](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L16)
+
+***
+
 ### request
 
 ▸ **request**(`operation`, `result`, `forward`): `void`
@@ -44,4 +67,4 @@
 
 *Defined in*
 
-[packages/cozy-client/src/CozyLink.js:8](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L8)
+[packages/cozy-client/src/CozyLink.js:12](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L12)
diff --git a/docs/api/cozy-client/classes/StackLink.md b/docs/api/cozy-client/classes/StackLink.md
@@ -62,7 +62,7 @@ Transfers queries and mutations to a remote stack
 
 *Defined in*
 
-[packages/cozy-client/src/StackLink.js:114](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L114)
+[packages/cozy-client/src/StackLink.js:118](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L118)
 
 ***
 
@@ -82,7 +82,32 @@ Transfers queries and mutations to a remote stack
 
 *Defined in*
 
-[packages/cozy-client/src/StackLink.js:91](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L91)
+[packages/cozy-client/src/StackLink.js:95](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L95)
+
+***
+
+### persistData
+
+▸ **persistData**(`data`, `forward`): `Promise`<`any`>
+
+*Parameters*
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `any` |
+| `forward` | `any` |
+
+*Returns*
+
+`Promise`<`any`>
+
+*Overrides*
+
+[CozyLink](CozyLink.md).[persistData](CozyLink.md#persistdata)
+
+*Defined in*
+
+[packages/cozy-client/src/StackLink.js:87](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L87)
 
 ***