Skip to content

Commit

Permalink
feat: Update golem-js API Reference for branch beta
Browse files Browse the repository at this point in the history
  • Loading branch information
cryptobench authored Feb 27, 2024
1 parent 305e193 commit adad9da
Show file tree
Hide file tree
Showing 145 changed files with 994 additions and 708 deletions.
12 changes: 12 additions & 0 deletions src/navigation/jsreference.js
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,10 @@ export const navigation = [
title: "NetworkNode",
href: "/docs/golem-js/reference/classes/network_node.NetworkNode"
},
{
title: "TcpProxy",
href: "/docs/golem-js/reference/classes/network_tcpProxy.TcpProxy"
},
{
title: "Package",
href: "/docs/golem-js/reference/classes/package_package.Package"
Expand Down Expand Up @@ -419,6 +423,10 @@ export const navigation = [
title: "PaymentOptions",
href: "/docs/golem-js/reference/interfaces/payment_service.PaymentOptions"
},
{
title: "PaymentServiceEvents",
href: "/docs/golem-js/reference/interfaces/payment_service.PaymentServiceEvents"
},
{
title: "StorageProvider",
href: "/docs/golem-js/reference/interfaces/storage_provider.StorageProvider"
Expand Down Expand Up @@ -544,6 +552,10 @@ export const navigation = [
title: "Network_service",
href: "/docs/golem-js/reference/modules/network_service"
},
{
title: "Network_tcpProxy",
href: "/docs/golem-js/reference/modules/network_tcpProxy"
},
{
title: "Package_package",
href: "/docs/golem-js/reference/modules/package_package"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ activity ID

#### Defined in

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

___

Expand All @@ -51,7 +51,7 @@ Agreement

#### Defined in

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

___

Expand All @@ -63,7 +63,7 @@ ___

#### Defined in

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

___

Expand All @@ -75,7 +75,7 @@ ___

#### Defined in

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

## Methods

Expand All @@ -102,7 +102,7 @@ Activity

#### Defined in

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

___

Expand All @@ -116,7 +116,7 @@ ___

#### Defined in

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

___

Expand All @@ -140,7 +140,7 @@ Execute script

#### Defined in

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

___

Expand All @@ -158,7 +158,7 @@ boolean

#### Defined in

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

___

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

#### Defined in

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

___

Expand All @@ -200,4 +200,4 @@ ___

#### Defined in

[src/activity/activity.ts:176](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L176)
[src/activity/activity.ts:176](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/activity.ts#L176)
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ type: "JS API Reference"

#### Defined in

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

## Properties

Expand All @@ -79,7 +79,7 @@ Index of script command

#### Defined in

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

___

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

#### Defined in

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

___

Expand All @@ -111,7 +111,7 @@ If is success

#### Defined in

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

___

Expand All @@ -127,7 +127,7 @@ stdout of script command

#### Defined in

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

___

Expand All @@ -143,7 +143,7 @@ stderr of script command

#### Defined in

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

___

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

#### Defined in

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

___

Expand All @@ -175,7 +175,7 @@ Is batch of already finished

#### Defined in

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

___

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

#### Defined in

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

## Methods

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

#### Defined in

[src/activity/results.ts:54](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L54)
[src/activity/results.ts:54](https://github.com/golemfactory/golem-js/blob/ef34064/src/activity/results.ts#L54)
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ type: "JS API Reference"

#### Defined in

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

## Properties

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

#### Defined in

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

___

Expand All @@ -57,4 +57,4 @@ ___

#### Defined in

[src/agreement/service.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/service.ts#L15)
[src/agreement/service.ts:15](https://github.com/golemfactory/golem-js/blob/ef34064/src/agreement/service.ts#L15)
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ CTRL+C abort error

#### Defined in

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

## Properties

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

#### Defined in

[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Api key not defined

#### Defined in

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

## Properties

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

#### Defined in

[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Error.constructor

#### Defined in

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

## Properties

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

#### Defined in

[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ JSON.parse(undefined) -> Error: Unexpected token u in JSON at position 0

#### Defined in

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

## Properties

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

#### Defined in

[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ additionally containing an error code specific to a given subdomain

#### Defined in

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

## Properties

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

#### Defined in

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

___

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

#### Defined in

[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Represents errors resulting from yagna’s errors or provider failure

#### Defined in

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

## Properties

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

#### Defined in

[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ SDK timeout errors

#### Defined in

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

## Properties

Expand All @@ -70,4 +70,4 @@ The previous error, if any, that led to this error.

#### Defined in

[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ you cannot create an activity for an agreement that already expired

#### Defined in

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

## Properties

Expand All @@ -75,4 +75,4 @@ The previous error, if any, that led to this error.

#### Defined in

[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/error/golem-error.ts#L10)
[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/ef34064/src/error/golem-error.ts#L10)
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ type: "JS API Reference"

#### Defined in

[src/events/events.ts:29](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L29)
[src/events/events.ts:29](https://github.com/golemfactory/golem-js/blob/ef34064/src/events/events.ts#L29)

## Properties

Expand All @@ -71,7 +71,7 @@ type: "JS API Reference"

#### Defined in

[src/events/events.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L17)
[src/events/events.ts:17](https://github.com/golemfactory/golem-js/blob/ef34064/src/events/events.ts#L17)

___

Expand All @@ -85,7 +85,7 @@ ___

#### Defined in

[src/events/events.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L18)
[src/events/events.ts:18](https://github.com/golemfactory/golem-js/blob/ef34064/src/events/events.ts#L18)

___

Expand All @@ -99,4 +99,4 @@ ___

#### Defined in

[src/events/events.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L19)
[src/events/events.ts:19](https://github.com/golemfactory/golem-js/blob/ef34064/src/events/events.ts#L19)
Loading

0 comments on commit adad9da

Please sign in to comment.