Skip to content

Commit adad9da

Browse files
authored
feat: Update golem-js API Reference for branch beta
1 parent 305e193 commit adad9da

File tree

145 files changed

+994
-708
lines changed

Some content is hidden

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

145 files changed

+994
-708
lines changed

src/navigation/jsreference.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,10 @@ export const navigation = [
221221
title: "NetworkNode",
222222
href: "/docs/golem-js/reference/classes/network_node.NetworkNode"
223223
},
224+
{
225+
title: "TcpProxy",
226+
href: "/docs/golem-js/reference/classes/network_tcpProxy.TcpProxy"
227+
},
224228
{
225229
title: "Package",
226230
href: "/docs/golem-js/reference/classes/package_package.Package"
@@ -419,6 +423,10 @@ export const navigation = [
419423
title: "PaymentOptions",
420424
href: "/docs/golem-js/reference/interfaces/payment_service.PaymentOptions"
421425
},
426+
{
427+
title: "PaymentServiceEvents",
428+
href: "/docs/golem-js/reference/interfaces/payment_service.PaymentServiceEvents"
429+
},
422430
{
423431
title: "StorageProvider",
424432
href: "/docs/golem-js/reference/interfaces/storage_provider.StorageProvider"
@@ -544,6 +552,10 @@ export const navigation = [
544552
title: "Network_service",
545553
href: "/docs/golem-js/reference/modules/network_service"
546554
},
555+
{
556+
title: "Network_tcpProxy",
557+
href: "/docs/golem-js/reference/modules/network_tcpProxy"
558+
},
547559
{
548560
title: "Package_package",
549561
href: "/docs/golem-js/reference/modules/package_package"

src/pages/docs/golem-js/reference/classes/activity_activity.Activity.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ activity ID
3939

4040
#### Defined in
4141

42-
[src/activity/activity.ts:62](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L62)
42+
[src/activity/activity.ts:62](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/activity.ts#L62)
4343

4444
___
4545

@@ -51,7 +51,7 @@ Agreement
5151

5252
#### Defined in
5353

54-
[src/activity/activity.ts:63](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L63)
54+
[src/activity/activity.ts:63](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/activity.ts#L63)
5555

5656
___
5757

@@ -63,7 +63,7 @@ ___
6363

6464
#### Defined in
6565

66-
[src/activity/activity.ts:64](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L64)
66+
[src/activity/activity.ts:64](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/activity.ts#L64)
6767

6868
___
6969

@@ -75,7 +75,7 @@ ___
7575

7676
#### Defined in
7777

78-
[src/activity/activity.ts:65](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L65)
78+
[src/activity/activity.ts:65](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/activity.ts#L65)
7979

8080
## Methods
8181

@@ -102,7 +102,7 @@ Activity
102102

103103
#### Defined in
104104

105-
[src/activity/activity.ts:79](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L79)
105+
[src/activity/activity.ts:79](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/activity.ts#L79)
106106

107107
___
108108

@@ -116,7 +116,7 @@ ___
116116

117117
#### Defined in
118118

119-
[src/activity/activity.ts:89](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L89)
119+
[src/activity/activity.ts:89](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/activity.ts#L89)
120120

121121
___
122122

@@ -140,7 +140,7 @@ Execute script
140140

141141
#### Defined in
142142

143-
[src/activity/activity.ts:100](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L100)
143+
[src/activity/activity.ts:100](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/activity.ts#L100)
144144

145145
___
146146

@@ -158,7 +158,7 @@ boolean
158158

159159
#### Defined in
160160

161-
[src/activity/activity.ts:138](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L138)
161+
[src/activity/activity.ts:138](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/activity.ts#L138)
162162

163163
___
164164

@@ -180,7 +180,7 @@ Error when cannot query the state
180180

181181
#### Defined in
182182

183-
[src/activity/activity.ts:150](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L150)
183+
[src/activity/activity.ts:150](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/activity.ts#L150)
184184

185185
___
186186

@@ -200,4 +200,4 @@ ___
200200

201201
#### Defined in
202202

203-
[src/activity/activity.ts:176](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L176)
203+
[src/activity/activity.ts:176](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/activity.ts#L176)

src/pages/docs/golem-js/reference/classes/activity_results.Result.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ type: "JS API Reference"
6363

6464
#### Defined in
6565

66-
[src/activity/results.ts:40](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L40)
66+
[src/activity/results.ts:40](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/results.ts#L40)
6767

6868
## Properties
6969

@@ -79,7 +79,7 @@ Index of script command
7979

8080
#### Defined in
8181

82-
[src/activity/results.ts:31](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L31)
82+
[src/activity/results.ts:31](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/results.ts#L31)
8383

8484
___
8585

@@ -95,7 +95,7 @@ The datetime of the event on which the result was received
9595

9696
#### Defined in
9797

98-
[src/activity/results.ts:32](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L32)
98+
[src/activity/results.ts:32](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/results.ts#L32)
9999

100100
___
101101

@@ -111,7 +111,7 @@ If is success
111111

112112
#### Defined in
113113

114-
[src/activity/results.ts:33](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L33)
114+
[src/activity/results.ts:33](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/results.ts#L33)
115115

116116
___
117117

@@ -127,7 +127,7 @@ stdout of script command
127127

128128
#### Defined in
129129

130-
[src/activity/results.ts:34](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L34)
130+
[src/activity/results.ts:34](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/results.ts#L34)
131131

132132
___
133133

@@ -143,7 +143,7 @@ stderr of script command
143143

144144
#### Defined in
145145

146-
[src/activity/results.ts:35](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L35)
146+
[src/activity/results.ts:35](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/results.ts#L35)
147147

148148
___
149149

@@ -159,7 +159,7 @@ an error message if the result is not successful
159159

160160
#### Defined in
161161

162-
[src/activity/results.ts:36](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L36)
162+
[src/activity/results.ts:36](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/results.ts#L36)
163163

164164
___
165165

@@ -175,7 +175,7 @@ Is batch of already finished
175175

176176
#### Defined in
177177

178-
[src/activity/results.ts:37](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L37)
178+
[src/activity/results.ts:37](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/results.ts#L37)
179179

180180
___
181181

@@ -191,7 +191,7 @@ In case the command was related to upload or download, this will contain the tra
191191

192192
#### Defined in
193193

194-
[src/activity/results.ts:38](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L38)
194+
[src/activity/results.ts:38](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/results.ts#L38)
195195

196196
## Methods
197197

@@ -213,4 +213,4 @@ Helper method making JSON-like output results more accessible
213213

214214
#### Defined in
215215

216-
[src/activity/results.ts:54](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L54)
216+
[src/activity/results.ts:54](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/results.ts#L54)

src/pages/docs/golem-js/reference/classes/agreement_service.AgreementCandidate.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ type: "JS API Reference"
3737

3838
#### Defined in
3939

40-
[src/agreement/service.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/service.ts#L15)
40+
[src/agreement/service.ts:15](https://github.com/golemfactory/golem-js/blob/ef34064/src/agreement/service.ts#L15)
4141

4242
## Properties
4343

@@ -47,7 +47,7 @@ type: "JS API Reference"
4747

4848
#### Defined in
4949

50-
[src/agreement/service.ts:14](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/service.ts#L14)
50+
[src/agreement/service.ts:14](https://github.com/golemfactory/golem-js/blob/ef34064/src/agreement/service.ts#L14)
5151

5252
___
5353

@@ -57,4 +57,4 @@ ___
5757

5858
#### Defined in
5959

60-
[src/agreement/service.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/service.ts#L15)
60+
[src/agreement/service.ts:15](https://github.com/golemfactory/golem-js/blob/ef34064/src/agreement/service.ts#L15)

src/pages/docs/golem-js/reference/classes/error_golem_error.GolemAbortError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ CTRL+C abort error
5555

5656
#### Defined in
5757

58-
[src/error/golem-error.ts:5](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L5)
58+
[src/error/golem-error.ts:5](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L5)
5959

6060
## Properties
6161

@@ -71,4 +71,4 @@ The previous error, if any, that led to this error.
7171

7272
#### Defined in
7373

74-
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
74+
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)

src/pages/docs/golem-js/reference/classes/error_golem_error.GolemConfigError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Api key not defined
5555

5656
#### Defined in
5757

58-
[src/error/golem-error.ts:5](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L5)
58+
[src/error/golem-error.ts:5](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L5)
5959

6060
## Properties
6161

@@ -71,4 +71,4 @@ The previous error, if any, that led to this error.
7171

7272
#### Defined in
7373

74-
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
74+
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)

src/pages/docs/golem-js/reference/classes/error_golem_error.GolemError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Error.constructor
5959

6060
#### Defined in
6161

62-
[src/error/golem-error.ts:5](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L5)
62+
[src/error/golem-error.ts:5](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L5)
6363

6464
## Properties
6565

@@ -71,4 +71,4 @@ The previous error, if any, that led to this error.
7171

7272
#### Defined in
7373

74-
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
74+
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)

src/pages/docs/golem-js/reference/classes/error_golem_error.GolemInternalError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ JSON.parse(undefined) -> Error: Unexpected token u in JSON at position 0
5555

5656
#### Defined in
5757

58-
[src/error/golem-error.ts:5](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L5)
58+
[src/error/golem-error.ts:5](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L5)
5959

6060
## Properties
6161

@@ -71,4 +71,4 @@ The previous error, if any, that led to this error.
7171

7272
#### Defined in
7373

74-
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
74+
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)

src/pages/docs/golem-js/reference/classes/error_golem_error.GolemModuleError.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ additionally containing an error code specific to a given subdomain
6161

6262
#### Defined in
6363

64-
[src/error/golem-error.ts:64](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L64)
64+
[src/error/golem-error.ts:64](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L64)
6565

6666
## Properties
6767

@@ -71,7 +71,7 @@ additionally containing an error code specific to a given subdomain
7171

7272
#### Defined in
7373

74-
[src/error/golem-error.ts:66](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L66)
74+
[src/error/golem-error.ts:66](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L66)
7575

7676
___
7777

@@ -87,4 +87,4 @@ The previous error, if any, that led to this error.
8787

8888
#### Defined in
8989

90-
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
90+
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)

src/pages/docs/golem-js/reference/classes/error_golem_error.GolemPlatformError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Represents errors resulting from yagna’s errors or provider failure
5252

5353
#### Defined in
5454

55-
[src/error/golem-error.ts:5](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L5)
55+
[src/error/golem-error.ts:5](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L5)
5656

5757
## Properties
5858

@@ -68,4 +68,4 @@ The previous error, if any, that led to this error.
6868

6969
#### Defined in
7070

71-
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
71+
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)

0 commit comments

Comments
 (0)