Skip to content

Commit 67db2ab

Browse files
committed
docs: Update types and documentation
1 parent d42348b commit 67db2ab

File tree

12 files changed

+98
-97
lines changed

12 files changed

+98
-97
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@
2929

3030
## Methods
3131

32-
### persistData
32+
### persistCozyData
3333

34-
**persistData**(`data`, `forward`): `void`
34+
**persistCozyData**(`data`, `forward`): `void`
3535

3636
*Parameters*
3737

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

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@
1919
| Name | Type | Description |
2020
| :------ | :------ | :------ |
2121
| `[options]` | `Object` | Options |
22-
| `[options].client` | `any` | - |
23-
| `[options].stackClient` | `any` | - |
2422
| `[options].webviewIntent` | `WebviewService` | - |
2523

2624
*Overrides*
@@ -29,33 +27,23 @@
2927

3028
*Defined in*
3129

32-
[packages/cozy-client/src/FlagshipLink.js:11](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L11)
30+
[packages/cozy-client/src/FlagshipLink.js:8](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L8)
3331

3432
## Properties
3533

36-
### stackClient
37-
38-
**stackClient**: `any`
39-
40-
*Defined in*
41-
42-
[packages/cozy-client/src/FlagshipLink.js:18](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L18)
43-
44-
***
45-
4634
### webviewIntent
4735

4836
**webviewIntent**: `WebviewService`
4937

5038
*Defined in*
5139

52-
[packages/cozy-client/src/FlagshipLink.js:19](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L19)
40+
[packages/cozy-client/src/FlagshipLink.js:10](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L10)
5341

5442
## Methods
5543

56-
### persistData
44+
### persistCozyData
5745

58-
**persistData**(`data`, `forward`): `Promise`<`void`>
46+
**persistCozyData**(`data`, `forward`): `Promise`<`void`>
5947

6048
*Parameters*
6149

@@ -70,11 +58,11 @@
7058

7159
*Overrides*
7260

73-
[CozyLink](CozyLink.md).[persistData](CozyLink.md#persistdata)
61+
[CozyLink](CozyLink.md).[persistCozyData](CozyLink.md#persistcozydata)
7462

7563
*Defined in*
7664

77-
[packages/cozy-client/src/FlagshipLink.js:34](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L34)
65+
[packages/cozy-client/src/FlagshipLink.js:25](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L25)
7866

7967
***
8068

@@ -94,7 +82,7 @@
9482

9583
*Defined in*
9684

97-
[packages/cozy-client/src/FlagshipLink.js:22](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L22)
85+
[packages/cozy-client/src/FlagshipLink.js:13](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L13)
9886

9987
***
10088

@@ -120,7 +108,7 @@
120108

121109
*Defined in*
122110

123-
[packages/cozy-client/src/FlagshipLink.js:30](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L30)
111+
[packages/cozy-client/src/FlagshipLink.js:21](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L21)
124112

125113
***
126114

@@ -134,4 +122,4 @@
134122

135123
*Defined in*
136124

137-
[packages/cozy-client/src/FlagshipLink.js:26](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L26)
125+
[packages/cozy-client/src/FlagshipLink.js:17](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L17)

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,9 @@ Transfers queries and mutations to a remote stack
9494

9595
***
9696

97-
### persistData
97+
### persistCozyData
9898

99-
**persistData**(`data`, `forward`): `Promise`<`any`>
99+
**persistCozyData**(`data`, `forward`): `Promise`<`any`>
100100

101101
*Parameters*
102102

@@ -111,7 +111,7 @@ Transfers queries and mutations to a remote stack
111111

112112
*Overrides*
113113

114-
[CozyLink](CozyLink.md).[persistData](CozyLink.md#persistdata)
114+
[CozyLink](CozyLink.md).[persistCozyData](CozyLink.md#persistcozydata)
115115

116116
*Defined in*
117117

0 commit comments

Comments
 (0)