Skip to content

Commit d101bfc

Browse files
committed
docs: Update types and documentation
1 parent 4433278 commit d101bfc

File tree

3 files changed

+24
-9
lines changed

3 files changed

+24
-9
lines changed

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

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Transfers queries and mutations to a remote stack
2222
| :------ | :------ | :------ |
2323
| `[options]` | `Object` | Options |
2424
| `[options].client` | `any` | - |
25+
| `[options].platform` | `any` | - |
2526
| `[options].stackClient` | `any` | - |
2627

2728
*Overrides*
@@ -30,17 +31,27 @@ Transfers queries and mutations to a remote stack
3031

3132
*Defined in*
3233

33-
[packages/cozy-client/src/StackLink.js:62](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L62)
34+
[packages/cozy-client/src/StackLink.js:64](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L64)
3435

3536
## Properties
3637

38+
### isOnline
39+
40+
**isOnline**: `any`
41+
42+
*Defined in*
43+
44+
[packages/cozy-client/src/StackLink.js:72](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L72)
45+
46+
***
47+
3748
### stackClient
3849

3950
**stackClient**: `any`
4051

4152
*Defined in*
4253

43-
[packages/cozy-client/src/StackLink.js:69](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L69)
54+
[packages/cozy-client/src/StackLink.js:71](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L71)
4455

4556
## Methods
4657

@@ -62,7 +73,7 @@ Transfers queries and mutations to a remote stack
6273

6374
*Defined in*
6475

65-
[packages/cozy-client/src/StackLink.js:118](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L118)
76+
[packages/cozy-client/src/StackLink.js:132](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L132)
6677

6778
***
6879

@@ -82,7 +93,7 @@ Transfers queries and mutations to a remote stack
8293

8394
*Defined in*
8495

85-
[packages/cozy-client/src/StackLink.js:95](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L95)
96+
[packages/cozy-client/src/StackLink.js:109](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L109)
8697

8798
***
8899

@@ -107,7 +118,7 @@ Transfers queries and mutations to a remote stack
107118

108119
*Defined in*
109120

110-
[packages/cozy-client/src/StackLink.js:87](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L87)
121+
[packages/cozy-client/src/StackLink.js:101](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L101)
111122

112123
***
113124

@@ -127,7 +138,7 @@ Transfers queries and mutations to a remote stack
127138

128139
*Defined in*
129140

130-
[packages/cozy-client/src/StackLink.js:72](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L72)
141+
[packages/cozy-client/src/StackLink.js:75](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L75)
131142

132143
***
133144

@@ -153,7 +164,7 @@ Transfers queries and mutations to a remote stack
153164

154165
*Defined in*
155166

156-
[packages/cozy-client/src/StackLink.js:80](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L80)
167+
[packages/cozy-client/src/StackLink.js:83](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L83)
157168

158169
***
159170

@@ -167,4 +178,4 @@ Transfers queries and mutations to a remote stack
167178

168179
*Defined in*
169180

170-
[packages/cozy-client/src/StackLink.js:76](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L76)
181+
[packages/cozy-client/src/StackLink.js:79](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/StackLink.js#L79)

packages/cozy-client/types/StackLink.d.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,15 @@ export default class StackLink extends CozyLink {
99
* @param {object} [options] - Options
1010
* @param {object} [options.stackClient] - A StackClient
1111
* @param {object} [options.client] - A StackClient (deprecated)
12+
* @param {import('cozy-pouch-link/dist/types').LinkPlatform} [options.platform] Platform specific adapters and methods
1213
*/
13-
constructor({ client, stackClient }?: {
14+
constructor({ client, stackClient, platform }?: {
1415
stackClient: object;
1516
client: object;
17+
platform: import('cozy-pouch-link/dist/types').LinkPlatform;
1618
});
1719
stackClient: any;
20+
isOnline: any;
1821
registerClient(client: any): void;
1922
reset(): void;
2023
/**

packages/cozy-client/types/utils.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ export function isQueryLoading(col: any): boolean;
22
export function hasQueryBeenLoaded(col: any): any;
33
export function isQueriesLoading(queriesResults: any): boolean;
44
export function hasQueriesBeenLoaded(queriesResults: any): boolean;
5+
export function isReactNativeOfflineError(err: Error): boolean;
56
export type CancelablePromise = Promise<any>;
67
/**
78
* @typedef {Promise} CancelablePromise

0 commit comments

Comments
 (0)