Skip to content

Commit 02632b9

Browse files
committed
docs: Update types dans documentation
1 parent 1df4c9c commit 02632b9

8 files changed

Lines changed: 299 additions & 135 deletions

File tree

docs/api/cozy-client/classes/CozyClient.md

Lines changed: 92 additions & 92 deletions
Large diffs are not rendered by default.

docs/api/cozy-client/classes/CozyLink.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,43 @@
1212

1313
### constructor
1414

15-
**new CozyLink**(`requestHandler`)
15+
**new CozyLink**(`requestHandler`, `persistHandler`)
1616

1717
*Parameters*
1818

1919
| Name | Type |
2020
| :------ | :------ |
2121
| `requestHandler` | `any` |
22+
| `persistHandler` | `any` |
2223

2324
*Defined in*
2425

2526
[packages/cozy-client/src/CozyLink.js:2](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L2)
2627

2728
## Methods
2829

30+
### persistData
31+
32+
**persistData**(`definition`, `data`, `forward`): `void`
33+
34+
*Parameters*
35+
36+
| Name | Type |
37+
| :------ | :------ |
38+
| `definition` | `any` |
39+
| `data` | `any` |
40+
| `forward` | `any` |
41+
42+
*Returns*
43+
44+
`void`
45+
46+
*Defined in*
47+
48+
[packages/cozy-client/src/CozyLink.js:16](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L16)
49+
50+
***
51+
2952
### request
3053

3154
**request**(`operation`, `result`, `forward`): `void`
@@ -44,4 +67,4 @@
4467

4568
*Defined in*
4669

47-
[packages/cozy-client/src/CozyLink.js:8](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L8)
70+
[packages/cozy-client/src/CozyLink.js:12](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/CozyLink.js#L12)

docs/api/cozy-client/classes/StackLink.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Transfers queries and mutations to a remote stack
6262

6363
*Defined in*
6464

65-
[packages/cozy-client/src/StackLink.js:114](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L114)
65+
[packages/cozy-client/src/StackLink.js:118](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L118)
6666

6767
***
6868

@@ -82,7 +82,32 @@ Transfers queries and mutations to a remote stack
8282

8383
*Defined in*
8484

85-
[packages/cozy-client/src/StackLink.js:91](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L91)
85+
[packages/cozy-client/src/StackLink.js:95](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L95)
86+
87+
***
88+
89+
### persistData
90+
91+
**persistData**(`data`, `forward`): `Promise`<`any`>
92+
93+
*Parameters*
94+
95+
| Name | Type |
96+
| :------ | :------ |
97+
| `data` | `any` |
98+
| `forward` | `any` |
99+
100+
*Returns*
101+
102+
`Promise`<`any`>
103+
104+
*Overrides*
105+
106+
[CozyLink](CozyLink.md).[persistData](CozyLink.md#persistdata)
107+
108+
*Defined in*
109+
110+
[packages/cozy-client/src/StackLink.js:87](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L87)
86111

87112
***
88113

0 commit comments

Comments
 (0)