Skip to content

Update golem-sdk-task-executor beta branch #240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: beta
Choose a base branch
from
Open

Update golem-sdk-task-executor beta branch #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
970 changes: 709 additions & 261 deletions src/navigation/jsreference.js
View file
Open in desktop

Large diffs are not rendered by default.

447 changes: 305 additions & 142 deletions src/pages/docs/golem-js/reference/README.md
View file
Open in desktop

Large diffs are not rendered by default.

164 changes: 61 additions & 103 deletions src/pages/docs/golem-js/reference/classes/activity_activity.Activity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,191 +13,149 @@ As part of a given activity, it is possible to execute exe script commands and c

## Table of contents

### Constructors

- [constructor](activity_activity.Activity#constructor)

### Properties

- [id](activity_activity.Activity#id)
- [agreement](activity_activity.Activity#agreement)
- [yagnaApi](activity_activity.Activity#yagnaapi)
- [options](activity_activity.Activity#options)
- [currentState](activity_activity.Activity#currentstate)
- [previousState](activity_activity.Activity#previousstate)
- [usage](activity_activity.Activity#usage)

### Methods
### Accessors

- [create](activity_activity.Activity#create)
- [getProviderInfo](activity_activity.Activity#getproviderinfo)
- [execute](activity_activity.Activity#execute)
- [stop](activity_activity.Activity#stop)
- [getState](activity_activity.Activity#getstate)
- [send](activity_activity.Activity#send)
- [provider](activity_activity.Activity#provider)

## Properties

### id
### Methods

• `Readonly` **id**: `string`
- [getState](activity_activity.Activity#getstate)
- [getPreviousState](activity_activity.Activity#getpreviousstate)

activity ID
## Constructors

#### Defined in
### constructor

[src/activity/activity.ts:62](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L62)
• **new Activity**(`id`, `agreement`, `currentState?`, `previousState?`, `usage`): [`Activity`](activity_activity.Activity)

___
#### Parameters

### agreement
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `id` | `string` | `undefined` | The ID of the activity in Yagna |
| `agreement` | [`Agreement`](market_agreement_agreement.Agreement) | `undefined` | The agreement that's related to this activity |
| `currentState` | [`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum) | `ActivityStateEnum.New` | The current state as it was obtained from yagna |
| `previousState` | [`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum) | `ActivityStateEnum.Unknown` | The previous state (or New if this is the first time we're creating the activity) |
| `usage` | [`ActivityUsageInfo`](../modules/activity_activity#activityusageinfo) | `undefined` | Current resource usage vector information |

• `Readonly` **agreement**: `Agreement`
#### Returns

Agreement
[`Activity`](activity_activity.Activity)

#### Defined in

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

___
## Properties

### yagnaApi
### id

• `Protected` `Readonly` **yagnaApi**: [`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi)
• `Readonly` **id**: `string`

[YagnaApi](../modules/utils_yagna_yagna#yagnaapi)
The ID of the activity in Yagna

#### Defined in

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

___

### options
### agreement

• `Protected` `Readonly` **options**: `ActivityConfig`
• `Readonly` **agreement**: [`Agreement`](market_agreement_agreement.Agreement)

[ActivityOptions](../interfaces/activity_activity.ActivityOptions)
The agreement that's related to this activity

#### Defined in

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

## Methods

### create

▸ **create**(`agreement`, `yagnaApi`, `options?`, `secure?`): `Promise`\<[`Activity`](activity_activity.Activity)\>

Create activity for given agreement ID
[src/activity/activity.ts:39](https://github.com/golemfactory/golem-js/blob/570126bc/src/activity/activity.ts#L39)

#### Parameters

| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `agreement` | `Agreement` | `undefined` | |
| `yagnaApi` | [`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi) | `undefined` | |
| `options?` | [`ActivityOptions`](../interfaces/activity_activity.ActivityOptions) | `undefined` | [ActivityOptions](../interfaces/activity_activity.ActivityOptions) |
| `secure` | `boolean` | `false` | defines if activity will be secure type |
___

#### Returns
### currentState

`Promise`\<[`Activity`](activity_activity.Activity)\>
• `Protected` `Readonly` **currentState**: [`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum) = `ActivityStateEnum.New`

Activity
The current state as it was obtained from yagna

#### Defined in

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

___

### getProviderInfo
### previousState

▸ **getProviderInfo**(): [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo)
• `Protected` `Readonly` **previousState**: [`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum) = `ActivityStateEnum.Unknown`

#### Returns

[`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo)
The previous state (or New if this is the first time we're creating the activity)

#### Defined in

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

___

### execute

▸ **execute**(`script`, `stream?`, `timeout?`): `Promise`\<`Readable`\>

Execute script

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `script` | [`ExeScriptRequest`](../interfaces/activity_activity.ExeScriptRequest) | exe script request |
| `stream?` | `boolean` | define type of getting results from execution (polling or streaming) |
| `timeout?` | `number` | execution timeout |
### usage

#### Returns
• `Protected` `Readonly` **usage**: [`ActivityUsageInfo`](../modules/activity_activity#activityusageinfo)

`Promise`\<`Readable`\>
Current resource usage vector information

#### Defined in

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

___
[src/activity/activity.ts:42](https://github.com/golemfactory/golem-js/blob/570126bc/src/activity/activity.ts#L42)

### stop
## Accessors

▸ **stop**(): `Promise`\<`boolean`\>
### provider

Stop and destroy activity
• `get` **provider**(): [`ProviderInfo`](../interfaces/market_agreement_agreement.ProviderInfo)

#### Returns

`Promise`\<`boolean`\>

boolean
[`ProviderInfo`](../interfaces/market_agreement_agreement.ProviderInfo)

#### Defined in

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

___
## Methods

### getState

▸ **getState**(): `Promise`\<[`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)\>

Getting current state of activity
▸ **getState**(): [`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)

#### Returns

`Promise`\<[`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)\>

state

**`Throws`**

Error when cannot query the state
[`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)

#### Defined in

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

___

### send

▸ **send**(`script`): `Promise`\<`string`\>

#### Parameters
### getPreviousState

| Name | Type |
| :------ | :------ |
| `script` | [`ExeScriptRequest`](../interfaces/activity_activity.ExeScriptRequest) |
▸ **getPreviousState**(): [`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)

#### Returns

`Promise`\<`string`\>
[`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)

#### Defined in

[src/activity/activity.ts:176](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L176)
[src/activity/activity.ts:53](https://github.com/golemfactory/golem-js/blob/570126bc/src/activity/activity.ts#L53)
Loading