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 9, 2024
1 parent 0963b62 commit 3eb3aa7
Show file tree
Hide file tree
Showing 12 changed files with 98 additions and 97 deletions.
4 changes: 2 additions & 2 deletions docs/api/cozy-client/classes/CozyLink.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@

## Methods

### persistData
### persistCozyData

**persistData**(`data`, `forward`): `void`
**persistCozyData**(`data`, `forward`): `void`

*Parameters*

Expand Down
30 changes: 9 additions & 21 deletions docs/api/cozy-client/classes/FlagshipLink.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@
| Name | Type | Description |
| :------ | :------ | :------ |
| `[options]` | `Object` | Options |
| `[options].client` | `any` | - |
| `[options].stackClient` | `any` | - |
| `[options].webviewIntent` | `WebviewService` | - |

*Overrides*
Expand All @@ -29,33 +27,23 @@

*Defined in*

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

## Properties

### stackClient

**stackClient**: `any`

*Defined in*

[packages/cozy-client/src/FlagshipLink.js:18](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L18)

***

### webviewIntent

**webviewIntent**: `WebviewService`

*Defined in*

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

## Methods

### persistData
### persistCozyData

**persistData**(`data`, `forward`): `Promise`<`void`>
**persistCozyData**(`data`, `forward`): `Promise`<`void`>

*Parameters*

Expand All @@ -70,11 +58,11 @@

*Overrides*

[CozyLink](CozyLink.md).[persistData](CozyLink.md#persistdata)
[CozyLink](CozyLink.md).[persistCozyData](CozyLink.md#persistcozydata)

*Defined in*

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

***

Expand All @@ -94,7 +82,7 @@

*Defined in*

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

***

Expand All @@ -120,7 +108,7 @@

*Defined in*

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

***

Expand All @@ -134,4 +122,4 @@

*Defined in*

[packages/cozy-client/src/FlagshipLink.js:26](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L26)
[packages/cozy-client/src/FlagshipLink.js:17](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/FlagshipLink.js#L17)
6 changes: 3 additions & 3 deletions docs/api/cozy-client/classes/StackLink.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ Transfers queries and mutations to a remote stack

***

### persistData
### persistCozyData

**persistData**(`data`, `forward`): `Promise`<`any`>
**persistCozyData**(`data`, `forward`): `Promise`<`any`>

*Parameters*

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

*Overrides*

[CozyLink](CozyLink.md).[persistData](CozyLink.md#persistdata)
[CozyLink](CozyLink.md).[persistCozyData](CozyLink.md#persistcozydata)

*Defined in*

Expand Down
Loading

0 comments on commit 3eb3aa7

Please sign in to comment.