Skip to content

Commit 52f9e04

Browse files
PierreJeanjacquotPierreJeanjacquot
authored
chore(dev-deps): bump typedoc suite (#519)
1 parent c4dfaea commit 52f9e04

File tree

185 files changed

+8413
-7836
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

185 files changed

+8413
-7836
lines changed

‎docs/-internal-/README.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
[**iexec**](../README.md)
2+
3+
***
4+
5+
[iexec](../globals.md) / \<internal\>
6+
7+
# \<internal\>
8+
9+
## Classes
10+
11+
- [BridgeObservable](classes/BridgeObservable.md)
12+
- [DealObservable](classes/DealObservable.md)
13+
- [ENSConfigurationObservable](classes/ENSConfigurationObservable.md)
14+
- [IExecContractsClient](classes/IExecContractsClient.md)
15+
- [TaskObservable](classes/TaskObservable.md)
16+
17+
## Interfaces
18+
19+
- [App](interfaces/App.md)
20+
- [AppDeploymentArgs](interfaces/AppDeploymentArgs.md)
21+
- [ApporderTemplate](interfaces/ApporderTemplate.md)
22+
- [Category](interfaces/Category.md)
23+
- [ConsumableApporder](interfaces/ConsumableApporder.md)
24+
- [ConsumableDatasetorder](interfaces/ConsumableDatasetorder.md)
25+
- [ConsumableRequestorder](interfaces/ConsumableRequestorder.md)
26+
- [ConsumableWorkerpoolorder](interfaces/ConsumableWorkerpoolorder.md)
27+
- [Dataset](interfaces/Dataset.md)
28+
- [DatasetDeploymentArgs](interfaces/DatasetDeploymentArgs.md)
29+
- [DatasetorderTemplate](interfaces/DatasetorderTemplate.md)
30+
- [GramineMREnclave](interfaces/GramineMREnclave.md)
31+
- [HashableApporder](interfaces/HashableApporder.md)
32+
- [HashableDatasetorder](interfaces/HashableDatasetorder.md)
33+
- [HashableRequestorder](interfaces/HashableRequestorder.md)
34+
- [HashableWorkerpoolorder](interfaces/HashableWorkerpoolorder.md)
35+
- [PaginableDeals](interfaces/PaginableDeals.md)
36+
- [PaginableOrders](interfaces/PaginableOrders.md)
37+
- [PublishedApporder](interfaces/PublishedApporder.md)
38+
- [PublishedDatasetorder](interfaces/PublishedDatasetorder.md)
39+
- [PublishedRequestorder](interfaces/PublishedRequestorder.md)
40+
- [PublishedWorkerpoolorder](interfaces/PublishedWorkerpoolorder.md)
41+
- [RequestorderParams](interfaces/RequestorderParams.md)
42+
- [RequestorderTemplate](interfaces/RequestorderTemplate.md)
43+
- [SconeMREnclave](interfaces/SconeMREnclave.md)
44+
- [SignableApporder](interfaces/SignableApporder.md)
45+
- [SignableDatasetorder](interfaces/SignableDatasetorder.md)
46+
- [SignableRequestorder](interfaces/SignableRequestorder.md)
47+
- [SignableWorkerpoolorder](interfaces/SignableWorkerpoolorder.md)
48+
- [SignedApporder](interfaces/SignedApporder.md)
49+
- [SignedDatasetorder](interfaces/SignedDatasetorder.md)
50+
- [SignedRequestorder](interfaces/SignedRequestorder.md)
51+
- [SignedWorkerpoolorder](interfaces/SignedWorkerpoolorder.md)
52+
- [Task](interfaces/Task.md)
53+
- [VoucherInfo](interfaces/VoucherInfo.md)
54+
- [Workerpool](interfaces/Workerpool.md)
55+
- [WorkerpoolDeploymentArgs](interfaces/WorkerpoolDeploymentArgs.md)
56+
- [WorkerpoolorderTemplate](interfaces/WorkerpoolorderTemplate.md)

‎docs/-internal-/classes/BridgeObservable.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
[**iexec**](../../README.md)
2+
3+
***
4+
5+
[iexec](../../globals.md) / [\<internal\>](../README.md) / BridgeObservable
6+
7+
# Class: BridgeObservable
8+
9+
## Extends
10+
11+
- [`Observable`](../../classes/Observable.md)
12+
13+
## Constructors
14+
15+
### Constructor
16+
17+
> **new BridgeObservable**(): `BridgeObservable`
18+
19+
#### Returns
20+
21+
`BridgeObservable`
22+
23+
#### Inherited from
24+
25+
[`Observable`](../../classes/Observable.md).[`constructor`](../../classes/Observable.md#constructor)
26+
27+
## Methods
28+
29+
### subscribe()
30+
31+
> **subscribe**(`callbacks`): () => `void`
32+
33+
subscribe and start the bridge process to transfer tokens from one chain to another until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned cancel method.
34+
35+
return the `cancel: () => void` method.
36+
37+
data:
38+
| message | comment | additional entries |
39+
| --- | --- | --- |
40+
| `CHECK_BRIDGE_POLICY` | sent once | |
41+
| `BRIDGE_POLICY_CHECKED` | sent once | `minPerTx`,`maxPerTx`,`dailyLimit` |
42+
| `CHECK_BRIDGE_LIMIT` | sent once | |
43+
| `BRIDGE_LIMIT_CHECKED` | sent once | `totalSpentPerDay` |
44+
| `SEND_TO_BRIDGE_TX_REQUEST` | sent once | `bridgeAddress` |
45+
| `SEND_TO_BRIDGE_TX_SUCCESS` | sent once | `txHash` |
46+
| `WAIT_RECEIVE_TX` | sent once if the bridged chain is configured | `bridgeAddress` |
47+
| `RECEIVE_TX_SUCCESS` | sent once if the bridged chain is configured | `txHash` |
48+
49+
#### Parameters
50+
51+
##### callbacks
52+
53+
###### complete?
54+
55+
() => `any`
56+
57+
callback fired once when the bridge process is completed
58+
59+
no other callback is fired after firing `complete()`
60+
61+
###### error?
62+
63+
(`error`) => `any`
64+
65+
callback fired once when an error occurs
66+
67+
no other callback is fired after firing `error(error: Error)`
68+
69+
###### next?
70+
71+
(`data`) => `any`
72+
73+
callback fired at every configuration step
74+
75+
data:
76+
| message | comment | additional entries |
77+
| --- | --- | --- |
78+
| `CHECK_BRIDGE_POLICY` | sent once | |
79+
| `BRIDGE_POLICY_CHECKED` | sent once | `minPerTx`,`maxPerTx`,`dailyLimit` |
80+
| `CHECK_BRIDGE_LIMIT` | sent once | |
81+
| `BRIDGE_LIMIT_CHECKED` | sent once | `totalSpentPerDay` |
82+
| `SEND_TO_BRIDGE_TX_REQUEST` | sent once | `bridgeAddress` |
83+
| `SEND_TO_BRIDGE_TX_SUCCESS` | sent once | `txHash` |
84+
| `WAIT_RECEIVE_TX` | sent once if the bridged chain is configured | `bridgeAddress` |
85+
| `RECEIVE_TX_SUCCESS` | sent once if the bridged chain is configured | `txHash` |
86+
87+
#### Returns
88+
89+
> (): `void`
90+
91+
##### Returns
92+
93+
`void`
94+
95+
#### Overrides
96+
97+
[`Observable`](../../classes/Observable.md).[`subscribe`](../../classes/Observable.md#subscribe)

‎docs/-internal-/classes/DealObservable.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
[**iexec**](../../README.md)
2+
3+
***
4+
5+
[iexec](../../globals.md) / [\<internal\>](../README.md) / DealObservable
6+
7+
# Class: DealObservable
8+
9+
## Extends
10+
11+
- [`Observable`](../../classes/Observable.md)
12+
13+
## Constructors
14+
15+
### Constructor
16+
17+
> **new DealObservable**(): `DealObservable`
18+
19+
#### Returns
20+
21+
`DealObservable`
22+
23+
#### Inherited from
24+
25+
[`Observable`](../../classes/Observable.md).[`constructor`](../../classes/Observable.md#constructor)
26+
27+
## Methods
28+
29+
### subscribe()
30+
31+
> **subscribe**(`callbacks`): () => `void`
32+
33+
subscribe to deal updates via an Observer until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned unsubscribe method.
34+
35+
return the `unsubscribe: () => void` method.
36+
37+
data:
38+
| message | comment |
39+
| --- | --- |
40+
| `DEAL_UPDATED` | sent every time a task status changes |
41+
| `DEAL_COMPLETED` | sent once all tasks are completed |
42+
| `DEAL_TIMEDOUT` | sent once the timeout is reached before all tasks completion |
43+
44+
#### Parameters
45+
46+
##### callbacks
47+
48+
###### complete?
49+
50+
() => `any`
51+
52+
callback fired once when all the tasks are completed or when the deadline is reached
53+
54+
no other callback is fired after firing `complete()`
55+
56+
###### error?
57+
58+
(`error`) => `any`
59+
60+
callback fired once when an error occurs
61+
62+
no other callback is fired after firing `error(error: Error)`
63+
64+
###### next?
65+
66+
(`data`) => `any`
67+
68+
callback fired with initial deal status and after every deal status update
69+
70+
data:
71+
| message | comment |
72+
| --- | --- |
73+
| `DEAL_UPDATED` | sent every time a task status changes |
74+
| `DEAL_COMPLETED` | sent once all tasks are completed |
75+
| `DEAL_TIMEDOUT` | sent once the timeout is reached before all tasks completion |
76+
77+
#### Returns
78+
79+
> (): `void`
80+
81+
##### Returns
82+
83+
`void`
84+
85+
#### Overrides
86+
87+
[`Observable`](../../classes/Observable.md).[`subscribe`](../../classes/Observable.md#subscribe)

docs/classes/internal_.ENSConfigurationObservable.md renamed to docs/-internal-/classes/ENSConfigurationObservable.md

Lines changed: 35 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,34 @@
1-
[iexec](../README.md) / [Exports](../modules.md) / [<internal\>](../modules/internal_.md) / ENSConfigurationObservable
1+
[**iexec**](../../README.md)
22

3-
# Class: ENSConfigurationObservable
4-
5-
[<internal>](../modules/internal_.md).ENSConfigurationObservable
6-
7-
## Hierarchy
8-
9-
- [`Observable`](Observable.md)
10-
11-
↳ **`ENSConfigurationObservable`**
3+
***
124

13-
## Table of contents
5+
[iexec](../../globals.md) / [\<internal\>](../README.md) / ENSConfigurationObservable
146

15-
### Constructors
16-
17-
- [constructor](internal_.ENSConfigurationObservable.md#constructor)
7+
# Class: ENSConfigurationObservable
188

19-
### Methods
9+
## Extends
2010

21-
- [subscribe](internal_.ENSConfigurationObservable.md#subscribe)
11+
- [`Observable`](../../classes/Observable.md)
2212

2313
## Constructors
2414

25-
### constructor
15+
### Constructor
2616

27-
• **new ENSConfigurationObservable**(): [`ENSConfigurationObservable`](internal_.ENSConfigurationObservable.md)
17+
> **new ENSConfigurationObservable**(): `ENSConfigurationObservable`
2818
2919
#### Returns
3020

31-
[`ENSConfigurationObservable`](internal_.ENSConfigurationObservable.md)
21+
`ENSConfigurationObservable`
3222

3323
#### Inherited from
3424

35-
[Observable](Observable.md).[constructor](Observable.md#constructor)
25+
[`Observable`](../../classes/Observable.md).[`constructor`](../../classes/Observable.md#constructor)
3626

3727
## Methods
3828

39-
### subscribe
29+
### subscribe()
4030

41-
▸ **subscribe**(`callbacks`): () => `void`
31+
> **subscribe**(`callbacks`): () => `void`
4232
4333
subscribe and start the ENS configuration process until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned cancel method.
4434

@@ -60,22 +50,29 @@ data:
6050

6151
#### Parameters
6252

63-
| Name | Type |
64-
| :------ | :------ |
65-
| `callbacks` | `Object` |
66-
| `callbacks.complete?` | () => `any` |
67-
| `callbacks.error?` | (`error`: `Error`) => `any` |
68-
| `callbacks.next?` | (`data`: { `address?`: `string` ; `addressType?`: `string` ; `message`: ``"DESCRIBE_WORKFLOW"`` \| ``"SET_RESOLVER_TX_REQUEST"`` \| ``"SET_RESOLVER_TX_SENT"`` \| ``"SET_RESOLVER_SUCCESS"`` \| ``"SET_ADDR_TX_REQUEST"`` \| ``"SET_ADDR_TX_SENT"`` \| ``"SET_ADDR_SUCCESS"`` \| ``"SET_NAME_TX_REQUEST"`` \| ``"SET_NAME_TX_SENT"`` \| ``"SET_NAME_SUCCESS"`` ; `name?`: `string` ; `resolverAddress?`: `string` ; `steps?`: `string`[] ; `txHash?`: `string` }) => `any` |
53+
##### callbacks
6954

70-
#### Returns
55+
###### complete?
7156

72-
`fn`
57+
() => `any`
7358

74-
▸ (): `void`
59+
callback fired once when the configuration is completed
7560

76-
subscribe and start the ENS configuration process until either `complete()` or `error(error: Error)` is called on the Observer or the subscribtion is canceled by calling the returned cancel method.
61+
no other callback is fired after firing `complete()`
7762

78-
return the `cancel: () => void` method.
63+
###### error?
64+
65+
(`error`) => `any`
66+
67+
callback fired once when an error occurs
68+
69+
no other callback is fired after firing `error(error: Error)`
70+
71+
###### next?
72+
73+
(`data`) => `any`
74+
75+
callback fired at every configuration step
7976

8077
data:
8178
| message | comment | additional entries |
@@ -91,10 +88,14 @@ data:
9188
| `SET_NAME_TX_SENT` | sent once if the name is not set | `txHash` |
9289
| `SET_NAME_SUCCESS` | sent once | `name`,`address` |
9390

91+
#### Returns
92+
93+
> (): `void`
94+
9495
##### Returns
9596

9697
`void`
9798

9899
#### Overrides
99100

100-
[Observable](Observable.md).[subscribe](Observable.md#subscribe)
101+
[`Observable`](../../classes/Observable.md).[`subscribe`](../../classes/Observable.md#subscribe)

0 commit comments

Comments
 (0)