diff --git a/src/navigation/jsreference.js b/src/navigation/jsreference.js index 15ed73a72..83a817e84 100644 --- a/src/navigation/jsreference.js +++ b/src/navigation/jsreference.js @@ -97,18 +97,6 @@ export const navigation = [ title: "CollectFailed", href: "/docs/golem-js/reference/classes/events_events.CollectFailed" }, -{ - title: "ComputationFailed", - href: "/docs/golem-js/reference/classes/events_events.ComputationFailed" - }, -{ - title: "ComputationFinished", - href: "/docs/golem-js/reference/classes/events_events.ComputationFinished" - }, -{ - title: "ComputationStarted", - href: "/docs/golem-js/reference/classes/events_events.ComputationStarted" - }, { title: "DebitNoteAccepted", href: "/docs/golem-js/reference/classes/events_events.DebitNoteAccepted" @@ -174,32 +162,24 @@ export const navigation = [ href: "/docs/golem-js/reference/classes/events_events.ScriptSent" }, { - title: "TaskFinished", - href: "/docs/golem-js/reference/classes/events_events.TaskFinished" - }, -{ - title: "TaskRedone", - href: "/docs/golem-js/reference/classes/events_events.TaskRedone" - }, -{ - title: "TaskRejected", - href: "/docs/golem-js/reference/classes/events_events.TaskRejected" + title: "GolemNetwork", + href: "/docs/golem-js/reference/classes/experimental_golem_network_golem_network.GolemNetwork" }, { - title: "TaskStarted", - href: "/docs/golem-js/reference/classes/events_events.TaskStarted" + title: "Job", + href: "/docs/golem-js/reference/classes/experimental_job_job.Job" }, { - title: "TaskExecutor", - href: "/docs/golem-js/reference/classes/executor_executor.TaskExecutor" + title: "GolemReputationError", + href: "/docs/golem-js/reference/classes/experimental_reputation_error.GolemReputationError" }, { - title: "GolemNetwork", - href: "/docs/golem-js/reference/classes/golem_network_golem_network.GolemNetwork" + title: "ReputationSystem", + href: "/docs/golem-js/reference/classes/experimental_reputation_system.ReputationSystem" }, { - title: "Job", - href: "/docs/golem-js/reference/classes/job_job.Job" + title: "GvmiServer", + href: "/docs/golem-js/reference/classes/gvmi_gvmiServer.GvmiServer" }, { title: "GolemMarketError", @@ -221,6 +201,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" @@ -265,41 +249,25 @@ export const navigation = [ title: "WebSocketBrowserStorageProvider", href: "/docs/golem-js/reference/classes/storage_ws_browser.WebSocketBrowserStorageProvider" }, +{ + title: "YagnaApi", + href: "/docs/golem-js/reference/classes/utils_yagna_yagnaApi.YagnaApi" + }, { title: "Batch", - href: "/docs/golem-js/reference/classes/task_batch.Batch" + href: "/docs/golem-js/reference/classes/work_batch.Batch" }, { title: "GolemWorkError", - href: "/docs/golem-js/reference/classes/task_error.GolemWorkError" + href: "/docs/golem-js/reference/classes/work_error.GolemWorkError" }, { title: "RemoteProcess", - href: "/docs/golem-js/reference/classes/task_process.RemoteProcess" - }, -{ - title: "Task", - href: "/docs/golem-js/reference/classes/task_task.Task" + href: "/docs/golem-js/reference/classes/work_process.RemoteProcess" }, { title: "WorkContext", - href: "/docs/golem-js/reference/classes/task_work.WorkContext" - }, -{ - title: "RequestorApi", - href: "/docs/golem-js/reference/classes/utils_yagna_activity.RequestorApi" - }, -{ - title: "RequestorApi", - href: "/docs/golem-js/reference/classes/utils_yagna_gsb.RequestorApi" - }, -{ - title: "RequestorApi", - href: "/docs/golem-js/reference/classes/utils_yagna_identity.RequestorApi" - }, -{ - title: "Yagna", - href: "/docs/golem-js/reference/classes/utils_yagna_yagna.Yagna" + href: "/docs/golem-js/reference/classes/work_work.WorkContext" } ] }, @@ -310,6 +278,10 @@ export const navigation = [ title: "ActivityStateEnum", href: "/docs/golem-js/reference/enums/activity_activity.ActivityStateEnum" }, +{ + title: "JobState", + href: "/docs/golem-js/reference/enums/experimental_job_job.JobState" + }, { title: "MarketErrorCode", href: "/docs/golem-js/reference/enums/market_error.MarketErrorCode" @@ -324,17 +296,17 @@ export const navigation = [ }, { title: "WorkErrorCode", - href: "/docs/golem-js/reference/enums/task_error.WorkErrorCode" - }, -{ - title: "TaskState", - href: "/docs/golem-js/reference/enums/task_task.TaskState" + href: "/docs/golem-js/reference/enums/work_error.WorkErrorCode" } ] }, { title: "interfaces", children: [ +{ + title: "ActivityEvents", + href: "/docs/golem-js/reference/interfaces/activity_activity.ActivityEvents" + }, { title: "ActivityOptions", href: "/docs/golem-js/reference/interfaces/activity_activity.ActivityOptions" @@ -343,6 +315,10 @@ export const navigation = [ title: "ExeScriptRequest", href: "/docs/golem-js/reference/interfaces/activity_activity.ExeScriptRequest" }, +{ + title: "ActivityFactoryEvents", + href: "/docs/golem-js/reference/interfaces/activity_factory.ActivityFactoryEvents" + }, { title: "ResultData", href: "/docs/golem-js/reference/interfaces/activity_results.ResultData" @@ -355,10 +331,18 @@ export const navigation = [ title: "StreamingBatchEvent", href: "/docs/golem-js/reference/interfaces/activity_results.StreamingBatchEvent" }, +{ + title: "AgreementEvents", + href: "/docs/golem-js/reference/interfaces/agreement_agreement.AgreementEvents" + }, { title: "ProviderInfo", href: "/docs/golem-js/reference/interfaces/agreement_agreement.ProviderInfo" }, +{ + title: "AgreementFactoryEvents", + href: "/docs/golem-js/reference/interfaces/agreement_factory.AgreementFactoryEvents" + }, { title: "AgreementDTO", href: "/docs/golem-js/reference/interfaces/agreement_service.AgreementDTO" @@ -368,25 +352,69 @@ export const navigation = [ href: "/docs/golem-js/reference/interfaces/agreement_service.AgreementServiceOptions" }, { - title: "TaskExecutorEventsDict", - href: "/docs/golem-js/reference/interfaces/executor_events.TaskExecutorEventsDict" + title: "JobEventsDict", + href: "/docs/golem-js/reference/interfaces/experimental_job_job.JobEventsDict" }, { - title: "JobEventsDict", - href: "/docs/golem-js/reference/interfaces/job_job.JobEventsDict" + title: "AgreementSelectorOption", + href: "/docs/golem-js/reference/interfaces/experimental_reputation_types.AgreementSelectorOption" + }, +{ + title: "ProposalFilterOptions", + href: "/docs/golem-js/reference/interfaces/experimental_reputation_types.ProposalFilterOptions" + }, +{ + title: "ReputationConfig", + href: "/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationConfig" + }, +{ + title: "ReputationData", + href: "/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationData" + }, +{ + title: "ReputationProviderEntry", + href: "/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationProviderEntry" + }, +{ + title: "ReputationProviderScores", + href: "/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationProviderScores" + }, +{ + title: "ReputationRejectedOperator", + href: "/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationRejectedOperator" + }, +{ + title: "ReputationRejectedProvider", + href: "/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationRejectedProvider" + }, +{ + title: "ReputationUntestedProvider", + href: "/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationUntestedProvider" }, { title: "DemandDetails", href: "/docs/golem-js/reference/interfaces/market_demand.DemandDetails" }, +{ + title: "DemandEvents", + href: "/docs/golem-js/reference/interfaces/market_demand.DemandEvents" + }, { title: "DemandOptions", href: "/docs/golem-js/reference/interfaces/market_demand.DemandOptions" }, +{ + title: "DemandFactoryEvents", + href: "/docs/golem-js/reference/interfaces/market_factory.DemandFactoryEvents" + }, { title: "ProposalDetails", href: "/docs/golem-js/reference/interfaces/market_proposal.ProposalDetails" }, +{ + title: "ProposalEvents", + href: "/docs/golem-js/reference/interfaces/market_proposal.ProposalEvents" + }, { title: "MarketOptions", href: "/docs/golem-js/reference/interfaces/market_service.MarketOptions" @@ -407,10 +435,22 @@ export const navigation = [ title: "DebitNoteDTO", href: "/docs/golem-js/reference/interfaces/payment_debit_note.DebitNoteDTO" }, +{ + title: "DebitNoteEvents", + href: "/docs/golem-js/reference/interfaces/payment_debit_note.DebitNoteEvents" + }, { title: "InvoiceDTO", href: "/docs/golem-js/reference/interfaces/payment_invoice.InvoiceDTO" }, +{ + title: "InvoiceEvents", + href: "/docs/golem-js/reference/interfaces/payment_invoice.InvoiceEvents" + }, +{ + title: "PaymentEvents", + href: "/docs/golem-js/reference/interfaces/payment_payments.PaymentEvents" + }, { title: "PaymentOptions", href: "/docs/golem-js/reference/interfaces/payment_payments.PaymentOptions" @@ -419,6 +459,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" @@ -428,24 +472,16 @@ export const navigation = [ href: "/docs/golem-js/reference/interfaces/storage_ws_browser.WebSocketStorageProviderOptions" }, { - title: "TaskServiceOptions", - href: "/docs/golem-js/reference/interfaces/task_service.TaskServiceOptions" + title: "Logger", + href: "/docs/golem-js/reference/interfaces/utils_logger_logger.Logger" }, { title: "CommandOptions", - href: "/docs/golem-js/reference/interfaces/task_work.CommandOptions" + href: "/docs/golem-js/reference/interfaces/work_work.CommandOptions" }, { title: "WorkOptions", - href: "/docs/golem-js/reference/interfaces/task_work.WorkOptions" - }, -{ - title: "Logger", - href: "/docs/golem-js/reference/interfaces/utils_logger_logger.Logger" - }, -{ - title: "IdentityModel", - href: "/docs/golem-js/reference/interfaces/utils_yagna_identity.IdentityModel" + href: "/docs/golem-js/reference/interfaces/work_work.WorkOptions" } ] }, @@ -456,6 +492,10 @@ export const navigation = [ title: "Activity_activity", href: "/docs/golem-js/reference/modules/activity_activity" }, +{ + title: "Activity_factory", + href: "/docs/golem-js/reference/modules/activity_factory" + }, { title: "Activity_results", href: "/docs/golem-js/reference/modules/activity_results" @@ -464,6 +504,10 @@ export const navigation = [ title: "Agreement_agreement", href: "/docs/golem-js/reference/modules/agreement_agreement" }, +{ + title: "Agreement_factory", + href: "/docs/golem-js/reference/modules/agreement_factory" + }, { title: "Agreement_service", href: "/docs/golem-js/reference/modules/agreement_service" @@ -481,20 +525,28 @@ export const navigation = [ href: "/docs/golem-js/reference/modules/events_events" }, { - title: "Executor_events", - href: "/docs/golem-js/reference/modules/executor_events" + title: "Experimental_golem_network_golem_network", + href: "/docs/golem-js/reference/modules/experimental_golem_network_golem_network" }, { - title: "Executor_executor", - href: "/docs/golem-js/reference/modules/executor_executor" + title: "Experimental_job_job", + href: "/docs/golem-js/reference/modules/experimental_job_job" }, { - title: "Golem_network_golem_network", - href: "/docs/golem-js/reference/modules/golem_network_golem_network" + title: "Experimental_reputation_error", + href: "/docs/golem-js/reference/modules/experimental_reputation_error" }, { - title: "Job_job", - href: "/docs/golem-js/reference/modules/job_job" + title: "Experimental_reputation_system", + href: "/docs/golem-js/reference/modules/experimental_reputation_system" + }, +{ + title: "Experimental_reputation_types", + href: "/docs/golem-js/reference/modules/experimental_reputation_types" + }, +{ + title: "Gvmi_gvmiServer", + href: "/docs/golem-js/reference/modules/gvmi_gvmiServer" }, { title: "Market_builder", @@ -508,6 +560,10 @@ export const navigation = [ title: "Market_error", href: "/docs/golem-js/reference/modules/market_error" }, +{ + title: "Market_factory", + href: "/docs/golem-js/reference/modules/market_factory" + }, { title: "Market_helpers", href: "/docs/golem-js/reference/modules/market_helpers" @@ -544,6 +600,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" @@ -604,30 +664,6 @@ export const navigation = [ title: "Storage_ws_browser", href: "/docs/golem-js/reference/modules/storage_ws_browser" }, -{ - title: "Task_batch", - href: "/docs/golem-js/reference/modules/task_batch" - }, -{ - title: "Task_error", - href: "/docs/golem-js/reference/modules/task_error" - }, -{ - title: "Task_process", - href: "/docs/golem-js/reference/modules/task_process" - }, -{ - title: "Task_service", - href: "/docs/golem-js/reference/modules/task_service" - }, -{ - title: "Task_task", - href: "/docs/golem-js/reference/modules/task_task" - }, -{ - title: "Task_work", - href: "/docs/golem-js/reference/modules/task_work" - }, { title: "Utils_env", href: "/docs/golem-js/reference/modules/utils_env" @@ -636,10 +672,6 @@ export const navigation = [ title: "Utils_logger_defaultLogger", href: "/docs/golem-js/reference/modules/utils_logger_defaultLogger" }, -{ - title: "Utils_logger_jsonLogger", - href: "/docs/golem-js/reference/modules/utils_logger_jsonLogger" - }, { title: "Utils_logger_logger", href: "/docs/golem-js/reference/modules/utils_logger_logger" @@ -648,33 +680,37 @@ export const navigation = [ title: "Utils_logger_nullLogger", href: "/docs/golem-js/reference/modules/utils_logger_nullLogger" }, -{ - title: "Utils_logger_pinoLogger", - href: "/docs/golem-js/reference/modules/utils_logger_pinoLogger" - }, { title: "Utils_runtimeContextChecker", href: "/docs/golem-js/reference/modules/utils_runtimeContextChecker" }, +{ + title: "Utils_timeout", + href: "/docs/golem-js/reference/modules/utils_timeout" + }, { title: "Utils_types", href: "/docs/golem-js/reference/modules/utils_types" }, { - title: "Utils_yagna_activity", - href: "/docs/golem-js/reference/modules/utils_yagna_activity" + title: "Utils_yagna_yagnaApi", + href: "/docs/golem-js/reference/modules/utils_yagna_yagnaApi" + }, +{ + title: "Work_batch", + href: "/docs/golem-js/reference/modules/work_batch" }, { - title: "Utils_yagna_gsb", - href: "/docs/golem-js/reference/modules/utils_yagna_gsb" + title: "Work_error", + href: "/docs/golem-js/reference/modules/work_error" }, { - title: "Utils_yagna_identity", - href: "/docs/golem-js/reference/modules/utils_yagna_identity" + title: "Work_process", + href: "/docs/golem-js/reference/modules/work_process" }, { - title: "Utils_yagna_yagna", - href: "/docs/golem-js/reference/modules/utils_yagna_yagna" + title: "Work_work", + href: "/docs/golem-js/reference/modules/work_work" } ] } diff --git a/src/pages/docs/golem-js/reference/README.md b/src/pages/docs/golem-js/reference/README.md index 42b5f2f50..781a71ae9 100644 --- a/src/pages/docs/golem-js/reference/README.md +++ b/src/pages/docs/golem-js/reference/README.md @@ -50,7 +50,7 @@ distributed, computational loads through Golem Network. ## System requirements -To use `golem-js`, it is necessary to have yagna installed, with a **minimum version requirement of v0.13.2**. Yagna is a +To use `golem-js`, it is necessary to have yagna installed, with a **recommended minimum version of v0.14.0**. Yagna is a service that communicates and performs operations on the Golem Network, upon your requests via the SDK. You can [follow these instructions](https://docs.golem.network/docs/creators/javascript/quickstarts/quickstart#install-yagna-2) to set it up. @@ -72,13 +72,13 @@ yagna service run # IN SEPARATE TERMINAL (if not daemonized) # Initialize your requestor -yagna payment init --sender --network goerli +yagna payment init --sender --network holesky # Request funds on the test network -yagna payment fund --network goerli +yagna payment fund --network holesky # Check the status of the funds -yagna payment status --network goerli +yagna payment status --network holesky ``` #### Obtain your `app-key` to use with SDK diff --git a/src/pages/docs/golem-js/reference/classes/activity_activity.Activity.md b/src/pages/docs/golem-js/reference/classes/activity_activity.Activity.md index cacf3b4e3..c485acfa2 100644 --- a/src/pages/docs/golem-js/reference/classes/activity_activity.Activity.md +++ b/src/pages/docs/golem-js/reference/classes/activity_activity.Activity.md @@ -15,6 +15,7 @@ As part of a given activity, it is possible to execute exe script commands and c ### Properties +- [events](activity_activity.Activity#events) - [id](activity_activity.Activity#id) - [agreement](activity_activity.Activity#agreement) - [yagnaApi](activity_activity.Activity#yagnaapi) @@ -31,6 +32,16 @@ As part of a given activity, it is possible to execute exe script commands and c ## Properties +### events + +• `Readonly` **events**: `EventEmitter`\<[`ActivityEvents`](../interfaces/activity_activity.ActivityEvents), `any`\> + +#### Defined in + +[src/activity/activity.ts:59](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L59) + +___ + ### id • `Readonly` **id**: `string` @@ -39,7 +50,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:69](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L69) ___ @@ -51,19 +62,19 @@ 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:70](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L70) ___ ### yagnaApi -• `Protected` `Readonly` **yagnaApi**: [`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi) +• `Protected` `Readonly` **yagnaApi**: [`YagnaApi`](utils_yagna_yagnaApi.YagnaApi) -[YagnaApi](../modules/utils_yagna_yagna#yagnaapi) +[YagnaApi](utils_yagna_yagnaApi.YagnaApi) #### Defined in -[src/activity/activity.ts:64](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L64) +[src/activity/activity.ts:71](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L71) ___ @@ -75,7 +86,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:72](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L72) ## Methods @@ -90,7 +101,7 @@ Create activity for given agreement ID | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | | `agreement` | `Agreement` | `undefined` | | -| `yagnaApi` | [`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi) | `undefined` | | +| `yagnaApi` | [`YagnaApi`](utils_yagna_yagnaApi.YagnaApi) | `undefined` | | | `options?` | [`ActivityOptions`](../interfaces/activity_activity.ActivityOptions) | `undefined` | [ActivityOptions](../interfaces/activity_activity.ActivityOptions) | | `secure` | `boolean` | `false` | defines if activity will be secure type | @@ -102,7 +113,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:86](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L86) ___ @@ -116,7 +127,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:96](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L96) ___ @@ -140,7 +151,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:107](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L107) ___ @@ -158,7 +169,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:143](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L143) ___ @@ -180,7 +191,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:155](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L155) ___ @@ -200,4 +211,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:186](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L186) diff --git a/src/pages/docs/golem-js/reference/classes/activity_results.Result.md b/src/pages/docs/golem-js/reference/classes/activity_results.Result.md index b31a89a5d..dc8b3b77d 100644 --- a/src/pages/docs/golem-js/reference/classes/activity_results.Result.md +++ b/src/pages/docs/golem-js/reference/classes/activity_results.Result.md @@ -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:38](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L38) ## Properties @@ -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:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L29) ___ @@ -95,13 +95,13 @@ 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:30](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L30) ___ ### result -• **result**: `ExeScriptCommandResultResultEnum` +• **result**: ``"Ok"`` \| ``"Error"`` If is success @@ -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:31](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L31) ___ @@ -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:32](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L32) ___ @@ -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:33](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L33) ___ @@ -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:34](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L34) ___ @@ -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:35](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L35) ___ @@ -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:36](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L36) ## Methods @@ -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:52](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L52) diff --git a/src/pages/docs/golem-js/reference/classes/agreement_service.AgreementCandidate.md b/src/pages/docs/golem-js/reference/classes/agreement_service.AgreementCandidate.md index a76eacbce..a8afbbc62 100644 --- a/src/pages/docs/golem-js/reference/classes/agreement_service.AgreementCandidate.md +++ b/src/pages/docs/golem-js/reference/classes/agreement_service.AgreementCandidate.md @@ -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/8e8b5ef/src/agreement/service.ts#L15) ## Properties @@ -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/8e8b5ef/src/agreement/service.ts#L14) ___ @@ -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/8e8b5ef/src/agreement/service.ts#L15) diff --git a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemAbortError.md b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemAbortError.md index bfd727bbb..495fa10a9 100644 --- a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemAbortError.md +++ b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemAbortError.md @@ -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/8e8b5ef/src/error/golem-error.ts#L5) ## Properties @@ -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/8e8b5ef/src/error/golem-error.ts#L10) diff --git a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemConfigError.md b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemConfigError.md index 64579c4a7..36c73349d 100644 --- a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemConfigError.md +++ b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemConfigError.md @@ -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/8e8b5ef/src/error/golem-error.ts#L5) ## Properties @@ -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/8e8b5ef/src/error/golem-error.ts#L10) diff --git a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemError.md b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemError.md index 1943f9a20..e708d8b6c 100644 --- a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemError.md +++ b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemError.md @@ -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/8e8b5ef/src/error/golem-error.ts#L5) ## Properties @@ -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/8e8b5ef/src/error/golem-error.ts#L10) diff --git a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemInternalError.md b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemInternalError.md index cb6d88add..d255efd13 100644 --- a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemInternalError.md +++ b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemInternalError.md @@ -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/8e8b5ef/src/error/golem-error.ts#L5) ## Properties @@ -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/8e8b5ef/src/error/golem-error.ts#L10) diff --git a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemModuleError.md b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemModuleError.md index a74e73764..a09cc305c 100644 --- a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemModuleError.md +++ b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemModuleError.md @@ -18,13 +18,15 @@ additionally containing an error code specific to a given subdomain ↳ **`GolemModuleError`** + ↳↳ [`GolemReputationError`](experimental_reputation_error.GolemReputationError) + ↳↳ [`GolemMarketError`](market_error.GolemMarketError) ↳↳ [`GolemNetworkError`](network_error.GolemNetworkError) ↳↳ [`GolemPaymentError`](payment_error.GolemPaymentError) - ↳↳ [`GolemWorkError`](task_error.GolemWorkError) + ↳↳ [`GolemWorkError`](work_error.GolemWorkError) ## Table of contents @@ -48,7 +50,7 @@ additionally containing an error code specific to a given subdomain | Name | Type | | :------ | :------ | | `message` | `string` | -| `code` | `number` | +| `code` | `string` \| `number` | | `previous?` | `Error` | #### Returns @@ -61,17 +63,17 @@ 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/8e8b5ef/src/error/golem-error.ts#L64) ## Properties ### code -• **code**: `number` +• **code**: `string` \| `number` #### 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/8e8b5ef/src/error/golem-error.ts#L66) ___ @@ -87,4 +89,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/8e8b5ef/src/error/golem-error.ts#L10) diff --git a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemPlatformError.md b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemPlatformError.md index fa5bc3e6a..a08cf83a8 100644 --- a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemPlatformError.md +++ b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemPlatformError.md @@ -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/8e8b5ef/src/error/golem-error.ts#L5) ## Properties @@ -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/8e8b5ef/src/error/golem-error.ts#L10) diff --git a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemTimeoutError.md b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemTimeoutError.md index 22ebf181a..64d8b85a1 100644 --- a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemTimeoutError.md +++ b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemTimeoutError.md @@ -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/8e8b5ef/src/error/golem-error.ts#L5) ## Properties @@ -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/8e8b5ef/src/error/golem-error.ts#L10) diff --git a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemUserError.md b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemUserError.md index f56cde40e..cfcb408c0 100644 --- a/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemUserError.md +++ b/src/pages/docs/golem-js/reference/classes/error_golem_error.GolemUserError.md @@ -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/8e8b5ef/src/error/golem-error.ts#L5) ## Properties @@ -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/8e8b5ef/src/error/golem-error.ts#L10) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.ActivityCreated.md b/src/pages/docs/golem-js/reference/classes/events_events.ActivityCreated.md index 4f16d3b99..d162fad98 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.ActivityCreated.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.ActivityCreated.md @@ -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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -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/8e8b5ef/src/events/events.ts#L17) ___ @@ -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/8e8b5ef/src/events/events.ts#L18) ___ @@ -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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.ActivityDestroyed.md b/src/pages/docs/golem-js/reference/classes/events_events.ActivityDestroyed.md index 6b41440b3..d791bd020 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.ActivityDestroyed.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.ActivityDestroyed.md @@ -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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -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/8e8b5ef/src/events/events.ts#L17) ___ @@ -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/8e8b5ef/src/events/events.ts#L18) ___ @@ -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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.ActivityStateChanged.md b/src/pages/docs/golem-js/reference/classes/events_events.ActivityStateChanged.md index 18dcd3930..794cbe650 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.ActivityStateChanged.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.ActivityStateChanged.md @@ -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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -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/8e8b5ef/src/events/events.ts#L17) ___ @@ -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/8e8b5ef/src/events/events.ts#L18) ___ @@ -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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.AgreementConfirmed.md b/src/pages/docs/golem-js/reference/classes/events_events.AgreementConfirmed.md index 0163e8199..099e69e21 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.AgreementConfirmed.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.AgreementConfirmed.md @@ -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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -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/8e8b5ef/src/events/events.ts#L17) ___ @@ -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/8e8b5ef/src/events/events.ts#L18) ___ @@ -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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.AgreementCreated.md b/src/pages/docs/golem-js/reference/classes/events_events.AgreementCreated.md index e3cedec68..367d512af 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.AgreementCreated.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.AgreementCreated.md @@ -52,7 +52,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -75,7 +75,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -89,7 +89,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -103,4 +103,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.AgreementRejected.md b/src/pages/docs/golem-js/reference/classes/events_events.AgreementRejected.md index fe4945a01..c57b6473e 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.AgreementRejected.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.AgreementRejected.md @@ -51,7 +51,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -73,7 +73,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -87,7 +87,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -101,4 +101,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.AgreementTerminated.md b/src/pages/docs/golem-js/reference/classes/events_events.AgreementTerminated.md index bad11f24d..fb5262aa5 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.AgreementTerminated.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.AgreementTerminated.md @@ -51,7 +51,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -73,7 +73,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -87,7 +87,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -101,4 +101,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.AllocationCreated.md b/src/pages/docs/golem-js/reference/classes/events_events.AllocationCreated.md index e5cfcf422..0567490f1 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.AllocationCreated.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.AllocationCreated.md @@ -51,7 +51,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -73,7 +73,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -87,7 +87,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -101,4 +101,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.BaseEvent.md b/src/pages/docs/golem-js/reference/classes/events_events.BaseEvent.md index 96360b46f..b9ca5b90b 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.BaseEvent.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.BaseEvent.md @@ -20,20 +20,6 @@ type: "JS API Reference" ↳ **`BaseEvent`** - ↳↳ [`ComputationStarted`](events_events.ComputationStarted) - - ↳↳ [`ComputationFinished`](events_events.ComputationFinished) - - ↳↳ [`ComputationFailed`](events_events.ComputationFailed) - - ↳↳ [`TaskStarted`](events_events.TaskStarted) - - ↳↳ [`TaskRedone`](events_events.TaskRedone) - - ↳↳ [`TaskRejected`](events_events.TaskRejected) - - ↳↳ [`TaskFinished`](events_events.TaskFinished) - ↳↳ [`AllocationCreated`](events_events.AllocationCreated) ↳↳ [`DemandSubscribed`](events_events.DemandSubscribed) @@ -124,7 +110,7 @@ CustomEvent\<DataType\>.constructor #### 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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -138,7 +124,7 @@ CustomEvent.detail #### 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/8e8b5ef/src/events/events.ts#L17) ___ @@ -152,7 +138,7 @@ CustomEvent.name #### 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/8e8b5ef/src/events/events.ts#L18) ___ @@ -166,4 +152,4 @@ CustomEvent.timestamp #### 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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.CollectFailed.md b/src/pages/docs/golem-js/reference/classes/events_events.CollectFailed.md index 5c7211012..3874aa5e2 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.CollectFailed.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.CollectFailed.md @@ -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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -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/8e8b5ef/src/events/events.ts#L17) ___ @@ -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/8e8b5ef/src/events/events.ts#L18) ___ @@ -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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.ComputationFailed.md b/src/pages/docs/golem-js/reference/classes/events_events.ComputationFailed.md deleted file mode 100644 index fec35efce..000000000 --- a/src/pages/docs/golem-js/reference/classes/events_events.ComputationFailed.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: "Class ComputationFailed" -pageTitle: "Class ComputationFailed - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class ComputationFailed within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: ComputationFailed - -[events/events](../modules/events_events).ComputationFailed - -## Hierarchy - -- [`BaseEvent`](events_events.BaseEvent)\<\{ `reason?`: `string` }\> - - ↳ **`ComputationFailed`** - -## Table of contents - -### Constructors - -- [constructor](events_events.ComputationFailed#constructor) - -### Properties - -- [detail](events_events.ComputationFailed#detail) -- [name](events_events.ComputationFailed#name) -- [timestamp](events_events.ComputationFailed#timestamp) - -## Constructors - -### constructor - -• **new ComputationFailed**(`data`): [`ComputationFailed`](events_events.ComputationFailed) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Object` | -| `data.reason?` | `string` | - -#### Returns - -[`ComputationFailed`](events_events.ComputationFailed) - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[constructor](events_events.BaseEvent#constructor) - -#### Defined in - -[src/events/events.ts:29](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L29) - -## Properties - -### detail - -• `Readonly` **detail**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `reason?` | `string` | - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[detail](events_events.BaseEvent#detail) - -#### Defined in - -[src/events/events.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L17) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[name](events_events.BaseEvent#name) - -#### Defined in - -[src/events/events.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L18) - -___ - -### timestamp - -• `Readonly` **timestamp**: `number` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[timestamp](events_events.BaseEvent#timestamp) - -#### Defined in - -[src/events/events.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.ComputationFinished.md b/src/pages/docs/golem-js/reference/classes/events_events.ComputationFinished.md deleted file mode 100644 index 2aea1386b..000000000 --- a/src/pages/docs/golem-js/reference/classes/events_events.ComputationFinished.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "Class ComputationFinished" -pageTitle: "Class ComputationFinished - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class ComputationFinished within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: ComputationFinished - -[events/events](../modules/events_events).ComputationFinished - -## Hierarchy - -- [`BaseEvent`](events_events.BaseEvent)\<`undefined`\> - - ↳ **`ComputationFinished`** - -## Table of contents - -### Constructors - -- [constructor](events_events.ComputationFinished#constructor) - -### Properties - -- [detail](events_events.ComputationFinished#detail) -- [name](events_events.ComputationFinished#name) -- [timestamp](events_events.ComputationFinished#timestamp) - -## Constructors - -### constructor - -• **new ComputationFinished**(): [`ComputationFinished`](events_events.ComputationFinished) - -#### Returns - -[`ComputationFinished`](events_events.ComputationFinished) - -#### Overrides - -[BaseEvent](events_events.BaseEvent).[constructor](events_events.BaseEvent#constructor) - -#### Defined in - -[src/events/events.ts:40](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L40) - -## Properties - -### detail - -• `Readonly` **detail**: `undefined` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[detail](events_events.BaseEvent#detail) - -#### Defined in - -[src/events/events.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L17) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[name](events_events.BaseEvent#name) - -#### Defined in - -[src/events/events.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L18) - -___ - -### timestamp - -• `Readonly` **timestamp**: `number` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[timestamp](events_events.BaseEvent#timestamp) - -#### Defined in - -[src/events/events.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.ComputationStarted.md b/src/pages/docs/golem-js/reference/classes/events_events.ComputationStarted.md deleted file mode 100644 index cb405b42b..000000000 --- a/src/pages/docs/golem-js/reference/classes/events_events.ComputationStarted.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "Class ComputationStarted" -pageTitle: "Class ComputationStarted - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class ComputationStarted within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: ComputationStarted - -[events/events](../modules/events_events).ComputationStarted - -## Hierarchy - -- [`BaseEvent`](events_events.BaseEvent)\<`undefined`\> - - ↳ **`ComputationStarted`** - -## Table of contents - -### Constructors - -- [constructor](events_events.ComputationStarted#constructor) - -### Properties - -- [detail](events_events.ComputationStarted#detail) -- [name](events_events.ComputationStarted#name) -- [timestamp](events_events.ComputationStarted#timestamp) - -## Constructors - -### constructor - -• **new ComputationStarted**(): [`ComputationStarted`](events_events.ComputationStarted) - -#### Returns - -[`ComputationStarted`](events_events.ComputationStarted) - -#### Overrides - -[BaseEvent](events_events.BaseEvent).[constructor](events_events.BaseEvent#constructor) - -#### Defined in - -[src/events/events.ts:35](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L35) - -## Properties - -### detail - -• `Readonly` **detail**: `undefined` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[detail](events_events.BaseEvent#detail) - -#### Defined in - -[src/events/events.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L17) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[name](events_events.BaseEvent#name) - -#### Defined in - -[src/events/events.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L18) - -___ - -### timestamp - -• `Readonly` **timestamp**: `number` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[timestamp](events_events.BaseEvent#timestamp) - -#### Defined in - -[src/events/events.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.DebitNoteAccepted.md b/src/pages/docs/golem-js/reference/classes/events_events.DebitNoteAccepted.md index 05e2fa2dd..d61cd67af 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.DebitNoteAccepted.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.DebitNoteAccepted.md @@ -10,7 +10,7 @@ type: "JS API Reference" ## Hierarchy -- [`BaseEvent`](events_events.BaseEvent)\<\{ `id`: `string` ; `agreementId`: `string` ; `amount`: `number` ; `provider`: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) }\> +- [`BaseEvent`](events_events.BaseEvent)\<\{ `id`: `string` ; `agreementId`: `string` ; `amount`: `string` ; `provider`: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) }\> ↳ **`DebitNoteAccepted`** @@ -39,7 +39,7 @@ type: "JS API Reference" | `data` | `Object` | | `data.id` | `string` | | `data.agreementId` | `string` | -| `data.amount` | `number` | +| `data.amount` | `string` | | `data.provider` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | #### Returns @@ -52,7 +52,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -66,7 +66,7 @@ type: "JS API Reference" | :------ | :------ | | `id` | `string` | | `agreementId` | `string` | -| `amount` | `number` | +| `amount` | `string` | | `provider` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | #### Inherited from @@ -75,7 +75,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -89,7 +89,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -103,4 +103,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.DebitNoteReceived.md b/src/pages/docs/golem-js/reference/classes/events_events.DebitNoteReceived.md index ad769479f..19ab3572f 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.DebitNoteReceived.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.DebitNoteReceived.md @@ -10,7 +10,7 @@ type: "JS API Reference" ## Hierarchy -- [`BaseEvent`](events_events.BaseEvent)\<\{ `id`: `string` ; `agreementId`: `string` ; `activityId`: `string` ; `amount`: `number` ; `provider`: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) }\> +- [`BaseEvent`](events_events.BaseEvent)\<\{ `id`: `string` ; `agreementId`: `string` ; `activityId`: `string` ; `amount`: `string` ; `provider`: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) }\> ↳ **`DebitNoteReceived`** @@ -40,7 +40,7 @@ type: "JS API Reference" | `data.id` | `string` | | `data.agreementId` | `string` | | `data.activityId` | `string` | -| `data.amount` | `number` | +| `data.amount` | `string` | | `data.provider` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | #### Returns @@ -53,7 +53,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -68,7 +68,7 @@ type: "JS API Reference" | `id` | `string` | | `agreementId` | `string` | | `activityId` | `string` | -| `amount` | `number` | +| `amount` | `string` | | `provider` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | #### Inherited from @@ -77,7 +77,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -91,7 +91,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -105,4 +105,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.DemandFailed.md b/src/pages/docs/golem-js/reference/classes/events_events.DemandFailed.md index 6b34ea3be..6411a70db 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.DemandFailed.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.DemandFailed.md @@ -49,7 +49,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -69,7 +69,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -83,7 +83,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -97,4 +97,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.DemandSubscribed.md b/src/pages/docs/golem-js/reference/classes/events_events.DemandSubscribed.md index 186a12d48..0a0739f5e 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.DemandSubscribed.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.DemandSubscribed.md @@ -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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -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/8e8b5ef/src/events/events.ts#L17) ___ @@ -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/8e8b5ef/src/events/events.ts#L18) ___ @@ -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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.DemandUnsubscribed.md b/src/pages/docs/golem-js/reference/classes/events_events.DemandUnsubscribed.md index 79f5f6eda..7c81ad7d1 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.DemandUnsubscribed.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.DemandUnsubscribed.md @@ -49,7 +49,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -69,7 +69,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -83,7 +83,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -97,4 +97,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.InvoiceReceived.md b/src/pages/docs/golem-js/reference/classes/events_events.InvoiceReceived.md index 52819f74b..70662d805 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.InvoiceReceived.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.InvoiceReceived.md @@ -10,7 +10,7 @@ type: "JS API Reference" ## Hierarchy -- [`BaseEvent`](events_events.BaseEvent)\<\{ `id`: `string` ; `provider`: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) ; `agreementId`: `string` ; `amount`: `number` }\> +- [`BaseEvent`](events_events.BaseEvent)\<\{ `id`: `string` ; `provider`: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) ; `agreementId`: `string` ; `amount`: `string` }\> ↳ **`InvoiceReceived`** @@ -40,7 +40,7 @@ type: "JS API Reference" | `data.id` | `string` | | `data.provider` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | | `data.agreementId` | `string` | -| `data.amount` | `number` | +| `data.amount` | `string` | #### Returns @@ -52,7 +52,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -67,7 +67,7 @@ type: "JS API Reference" | `id` | `string` | | `provider` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | | `agreementId` | `string` | -| `amount` | `number` | +| `amount` | `string` | #### Inherited from @@ -75,7 +75,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -89,7 +89,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -103,4 +103,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.PackageCreated.md b/src/pages/docs/golem-js/reference/classes/events_events.PackageCreated.md index 609a42a84..06ca695de 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.PackageCreated.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.PackageCreated.md @@ -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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -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/8e8b5ef/src/events/events.ts#L17) ___ @@ -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/8e8b5ef/src/events/events.ts#L18) ___ @@ -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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.PaymentAccepted.md b/src/pages/docs/golem-js/reference/classes/events_events.PaymentAccepted.md index 3983313ba..26af575f3 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.PaymentAccepted.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.PaymentAccepted.md @@ -10,7 +10,7 @@ type: "JS API Reference" ## Hierarchy -- [`BaseEvent`](events_events.BaseEvent)\<\{ `id`: `string` ; `agreementId`: `string` ; `amount`: `number` ; `provider`: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) }\> +- [`BaseEvent`](events_events.BaseEvent)\<\{ `id`: `string` ; `agreementId`: `string` ; `amount`: `string` ; `provider`: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) }\> ↳ **`PaymentAccepted`** @@ -39,7 +39,7 @@ type: "JS API Reference" | `data` | `Object` | | `data.id` | `string` | | `data.agreementId` | `string` | -| `data.amount` | `number` | +| `data.amount` | `string` | | `data.provider` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | #### Returns @@ -52,7 +52,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -66,7 +66,7 @@ type: "JS API Reference" | :------ | :------ | | `id` | `string` | | `agreementId` | `string` | -| `amount` | `number` | +| `amount` | `string` | | `provider` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | #### Inherited from @@ -75,7 +75,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -89,7 +89,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -103,4 +103,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.PaymentFailed.md b/src/pages/docs/golem-js/reference/classes/events_events.PaymentFailed.md index e3c1d6155..780e1c8fa 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.PaymentFailed.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.PaymentFailed.md @@ -51,7 +51,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -73,7 +73,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -87,7 +87,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -101,4 +101,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.ProposalConfirmed.md b/src/pages/docs/golem-js/reference/classes/events_events.ProposalConfirmed.md index 010025115..7b275adb5 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.ProposalConfirmed.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.ProposalConfirmed.md @@ -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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -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/8e8b5ef/src/events/events.ts#L17) ___ @@ -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/8e8b5ef/src/events/events.ts#L18) ___ @@ -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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.ProposalFailed.md b/src/pages/docs/golem-js/reference/classes/events_events.ProposalFailed.md index dff4f71b4..f93085f19 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.ProposalFailed.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.ProposalFailed.md @@ -52,7 +52,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -75,7 +75,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -89,7 +89,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -103,4 +103,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.ProposalReceived.md b/src/pages/docs/golem-js/reference/classes/events_events.ProposalReceived.md index bec1b8766..3096c763b 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.ProposalReceived.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.ProposalReceived.md @@ -52,7 +52,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -75,7 +75,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -89,7 +89,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -103,4 +103,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.ProposalRejected.md b/src/pages/docs/golem-js/reference/classes/events_events.ProposalRejected.md index 323e9bcd1..81570a37f 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.ProposalRejected.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.ProposalRejected.md @@ -52,7 +52,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -75,7 +75,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -89,7 +89,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -103,4 +103,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.ProposalResponded.md b/src/pages/docs/golem-js/reference/classes/events_events.ProposalResponded.md index c3dcda22b..8e1dc437c 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.ProposalResponded.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.ProposalResponded.md @@ -51,7 +51,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -73,7 +73,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -87,7 +87,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -101,4 +101,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.ScriptExecuted.md b/src/pages/docs/golem-js/reference/classes/events_events.ScriptExecuted.md index 7756170c5..56c912d93 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.ScriptExecuted.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.ScriptExecuted.md @@ -51,7 +51,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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -73,7 +73,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/8e8b5ef/src/events/events.ts#L17) ___ @@ -87,7 +87,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/8e8b5ef/src/events/events.ts#L18) ___ @@ -101,4 +101,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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.ScriptSent.md b/src/pages/docs/golem-js/reference/classes/events_events.ScriptSent.md index bcc6711c3..db0b2def9 100644 --- a/src/pages/docs/golem-js/reference/classes/events_events.ScriptSent.md +++ b/src/pages/docs/golem-js/reference/classes/events_events.ScriptSent.md @@ -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/8e8b5ef/src/events/events.ts#L29) ## Properties @@ -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/8e8b5ef/src/events/events.ts#L17) ___ @@ -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/8e8b5ef/src/events/events.ts#L18) ___ @@ -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/8e8b5ef/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.TaskFinished.md b/src/pages/docs/golem-js/reference/classes/events_events.TaskFinished.md deleted file mode 100644 index b72c533db..000000000 --- a/src/pages/docs/golem-js/reference/classes/events_events.TaskFinished.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: "Class TaskFinished" -pageTitle: "Class TaskFinished - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class TaskFinished within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: TaskFinished - -[events/events](../modules/events_events).TaskFinished - -## Hierarchy - -- [`BaseEvent`](events_events.BaseEvent)\<\{ `id`: `string` }\> - - ↳ **`TaskFinished`** - -## Table of contents - -### Constructors - -- [constructor](events_events.TaskFinished#constructor) - -### Properties - -- [detail](events_events.TaskFinished#detail) -- [name](events_events.TaskFinished#name) -- [timestamp](events_events.TaskFinished#timestamp) - -## Constructors - -### constructor - -• **new TaskFinished**(`data`): [`TaskFinished`](events_events.TaskFinished) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Object` | -| `data.id` | `string` | - -#### Returns - -[`TaskFinished`](events_events.TaskFinished) - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[constructor](events_events.BaseEvent#constructor) - -#### Defined in - -[src/events/events.ts:29](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L29) - -## Properties - -### detail - -• `Readonly` **detail**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[detail](events_events.BaseEvent#detail) - -#### Defined in - -[src/events/events.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L17) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[name](events_events.BaseEvent#name) - -#### Defined in - -[src/events/events.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L18) - -___ - -### timestamp - -• `Readonly` **timestamp**: `number` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[timestamp](events_events.BaseEvent#timestamp) - -#### Defined in - -[src/events/events.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.TaskRedone.md b/src/pages/docs/golem-js/reference/classes/events_events.TaskRedone.md deleted file mode 100644 index dc183c1c1..000000000 --- a/src/pages/docs/golem-js/reference/classes/events_events.TaskRedone.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: "Class TaskRedone" -pageTitle: "Class TaskRedone - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class TaskRedone within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: TaskRedone - -[events/events](../modules/events_events).TaskRedone - -Represents the situation in which running the task failed for some reason, but it will be retried - -## Hierarchy - -- [`BaseEvent`](events_events.BaseEvent)\<\{ `id`: `string` ; `agreementId?`: `string` ; `provider?`: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) ; `retriesCount`: `number` ; `activityId?`: `string` ; `reason?`: `string` }\> - - ↳ **`TaskRedone`** - -## Table of contents - -### Constructors - -- [constructor](events_events.TaskRedone#constructor) - -### Properties - -- [detail](events_events.TaskRedone#detail) -- [name](events_events.TaskRedone#name) -- [timestamp](events_events.TaskRedone#timestamp) - -## Constructors - -### constructor - -• **new TaskRedone**(`data`): [`TaskRedone`](events_events.TaskRedone) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `Object` | - | -| `data.id` | `string` | - | -| `data.agreementId?` | `string` | - | -| `data.provider?` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | - | -| `data.retriesCount` | `number` | - | -| `data.activityId?` | `string` | The activity that was involved This might be not set when there was an issue with starting the activity on the provider | -| `data.reason?` | `string` | - | - -#### Returns - -[`TaskRedone`](events_events.TaskRedone) - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[constructor](events_events.BaseEvent#constructor) - -#### Defined in - -[src/events/events.ts:29](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L29) - -## Properties - -### detail - -• `Readonly` **detail**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | - | -| `agreementId?` | `string` | - | -| `provider?` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | - | -| `retriesCount` | `number` | - | -| `activityId?` | `string` | The activity that was involved This might be not set when there was an issue with starting the activity on the provider | -| `reason?` | `string` | - | - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[detail](events_events.BaseEvent#detail) - -#### Defined in - -[src/events/events.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L17) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[name](events_events.BaseEvent#name) - -#### Defined in - -[src/events/events.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L18) - -___ - -### timestamp - -• `Readonly` **timestamp**: `number` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[timestamp](events_events.BaseEvent#timestamp) - -#### Defined in - -[src/events/events.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.TaskRejected.md b/src/pages/docs/golem-js/reference/classes/events_events.TaskRejected.md deleted file mode 100644 index 77972e113..000000000 --- a/src/pages/docs/golem-js/reference/classes/events_events.TaskRejected.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: "Class TaskRejected" -pageTitle: "Class TaskRejected - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class TaskRejected within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: TaskRejected - -[events/events](../modules/events_events).TaskRejected - -Represents the situation where all attempts to execute the task have been unsuccessful and no further processing -will be conducted. - -## Hierarchy - -- [`BaseEvent`](events_events.BaseEvent)\<\{ `id`: `string` ; `agreementId?`: `string` ; `provider?`: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) ; `activityId?`: `string` ; `reason?`: `string` }\> - - ↳ **`TaskRejected`** - -## Table of contents - -### Constructors - -- [constructor](events_events.TaskRejected#constructor) - -### Properties - -- [detail](events_events.TaskRejected#detail) -- [name](events_events.TaskRejected#name) -- [timestamp](events_events.TaskRejected#timestamp) - -## Constructors - -### constructor - -• **new TaskRejected**(`data`): [`TaskRejected`](events_events.TaskRejected) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `Object` | - | -| `data.id` | `string` | - | -| `data.agreementId?` | `string` | - | -| `data.provider?` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | - | -| `data.activityId?` | `string` | The activity that was involved when the rejection took place This might be not set when there was an issue with starting the activity on the provider | -| `data.reason?` | `string` | - | - -#### Returns - -[`TaskRejected`](events_events.TaskRejected) - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[constructor](events_events.BaseEvent#constructor) - -#### Defined in - -[src/events/events.ts:29](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L29) - -## Properties - -### detail - -• `Readonly` **detail**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | - | -| `agreementId?` | `string` | - | -| `provider?` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | - | -| `activityId?` | `string` | The activity that was involved when the rejection took place This might be not set when there was an issue with starting the activity on the provider | -| `reason?` | `string` | - | - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[detail](events_events.BaseEvent#detail) - -#### Defined in - -[src/events/events.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L17) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[name](events_events.BaseEvent#name) - -#### Defined in - -[src/events/events.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L18) - -___ - -### timestamp - -• `Readonly` **timestamp**: `number` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[timestamp](events_events.BaseEvent#timestamp) - -#### Defined in - -[src/events/events.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/events_events.TaskStarted.md b/src/pages/docs/golem-js/reference/classes/events_events.TaskStarted.md deleted file mode 100644 index c671c6edb..000000000 --- a/src/pages/docs/golem-js/reference/classes/events_events.TaskStarted.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: "Class TaskStarted" -pageTitle: "Class TaskStarted - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class TaskStarted within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: TaskStarted - -[events/events](../modules/events_events).TaskStarted - -## Hierarchy - -- [`BaseEvent`](events_events.BaseEvent)\<\{ `id`: `string` ; `agreementId`: `string` ; `activityId`: `string` ; `provider`: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) }\> - - ↳ **`TaskStarted`** - -## Table of contents - -### Constructors - -- [constructor](events_events.TaskStarted#constructor) - -### Properties - -- [detail](events_events.TaskStarted#detail) -- [name](events_events.TaskStarted#name) -- [timestamp](events_events.TaskStarted#timestamp) - -## Constructors - -### constructor - -• **new TaskStarted**(`data`): [`TaskStarted`](events_events.TaskStarted) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Object` | -| `data.id` | `string` | -| `data.agreementId` | `string` | -| `data.activityId` | `string` | -| `data.provider` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | - -#### Returns - -[`TaskStarted`](events_events.TaskStarted) - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[constructor](events_events.BaseEvent#constructor) - -#### Defined in - -[src/events/events.ts:29](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L29) - -## Properties - -### detail - -• `Readonly` **detail**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `agreementId` | `string` | -| `activityId` | `string` | -| `provider` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[detail](events_events.BaseEvent#detail) - -#### Defined in - -[src/events/events.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L17) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[name](events_events.BaseEvent#name) - -#### Defined in - -[src/events/events.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L18) - -___ - -### timestamp - -• `Readonly` **timestamp**: `number` - -#### Inherited from - -[BaseEvent](events_events.BaseEvent).[timestamp](events_events.BaseEvent#timestamp) - -#### Defined in - -[src/events/events.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/classes/executor_executor.TaskExecutor.md b/src/pages/docs/golem-js/reference/classes/executor_executor.TaskExecutor.md deleted file mode 100644 index ddc34744a..000000000 --- a/src/pages/docs/golem-js/reference/classes/executor_executor.TaskExecutor.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -title: "Class TaskExecutor" -pageTitle: "Class TaskExecutor - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class TaskExecutor within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: TaskExecutor - -[executor/executor](../modules/executor_executor).TaskExecutor - -A high-level module for defining and executing tasks in the golem network - -## Table of contents - -### Constructors - -- [constructor](executor_executor.TaskExecutor#constructor) - -### Properties - -- [events](executor_executor.TaskExecutor#events) - -### Methods - -- [create](executor_executor.TaskExecutor#create) -- [init](executor_executor.TaskExecutor#init) -- [shutdown](executor_executor.TaskExecutor#shutdown) -- [getStats](executor_executor.TaskExecutor#getstats) -- [onActivityReady](executor_executor.TaskExecutor#onactivityready) -- [run](executor_executor.TaskExecutor#run) -- [cancel](executor_executor.TaskExecutor#cancel) - -## Constructors - -### constructor - -• **new TaskExecutor**(`options`): [`TaskExecutor`](executor_executor.TaskExecutor) - -Create a new TaskExecutor object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options` | [`ExecutorOptionsMixin`](../modules/executor_executor#executoroptionsmixin) | contains information needed to start executor, if string the imageHash is required, otherwise it should be a type of [ExecutorOptions](../modules/executor_executor#executoroptions) | - -#### Returns - -[`TaskExecutor`](executor_executor.TaskExecutor) - -#### Defined in - -[src/executor/executor.ts:169](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/executor.ts#L169) - -## Properties - -### events - -• `Readonly` **events**: `EventEmitter`\<[`TaskExecutorEventsDict`](../interfaces/executor_events.TaskExecutorEventsDict), `any`\> - -EventEmitter (EventEmitter3) instance emitting TaskExecutor events. - -**`See`** - -TaskExecutorEventsDict for available events. - -#### Defined in - -[src/executor/executor.ts:94](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/executor.ts#L94) - -## Methods - -### create - -▸ **create**(`options`): `Promise`\<[`TaskExecutor`](executor_executor.TaskExecutor)\> - -Create a new Task Executor - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options` | [`ExecutorOptionsMixin`](../modules/executor_executor#executoroptionsmixin) | Task executor options | - -#### Returns - -`Promise`\<[`TaskExecutor`](executor_executor.TaskExecutor)\> - -TaskExecutor - -**`Description`** - -Factory Method that create and initialize an instance of the TaskExecutor - -**`Example`** - -The executor can be created by passing appropriate initial parameters such as package, budget, subnet tag, payment driver, payment network etc. -One required parameter is a package. This can be done in two ways. First by passing only package image hash or image tag, e.g. -```js -const executor = await TaskExecutor.create("9a3b5d67b0b27746283cb5f287c13eab1beaa12d92a9f536b747c7ae"); -``` -or -```js -const executor = await TaskExecutor.create("golem/alpine:3.18.2"); -``` - -**`Example`** - -Or by passing some optional parameters, e.g. -```js -const executor = await TaskExecutor.create({ - subnetTag: "public", - payment: { driver: "erc-20", network: "goerli" }, - package: "golem/alpine:3.18.2", -}); -``` - -#### Defined in - -[src/executor/executor.ts:158](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/executor.ts#L158) - -___ - -### init - -▸ **init**(): `Promise`\<`void`\> - -Initialize executor - -#### Returns - -`Promise`\<`void`\> - -**`Description`** - -Method responsible initialize all executor services. - -#### Defined in - -[src/executor/executor.ts:222](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/executor.ts#L222) - -___ - -### shutdown - -▸ **shutdown**(): `Promise`\<`void`\> - -Stop all executor services and shut down executor instance. - -You can call this method multiple times, it will resolve only once the executor is shutdown. - -When shutdown() is initially called, a beforeEnd event is emitted. - -Once the executor is fully stopped, an end event is emitted. - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/executor/executor.ts:286](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/executor.ts#L286) - -___ - -### getStats - -▸ **getStats**(): `Object` - -Statistics of execution process - -#### Returns - -`Object` - -array - -#### Defined in - -[src/executor/executor.ts:323](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/executor.ts#L323) - -___ - -### onActivityReady - -▸ **onActivityReady**(`worker`): `void` - -Registers a worker function that will be run when an activity is ready. -This is the perfect place to run setup functions that need to be run only once per -activity, for example uploading files that will be used by all tasks in the activity. -This function can be called multiple times, each worker will be run in the order -they were registered. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `worker` | [`Worker`](../modules/task_work#worker)\<`unknown`\> | worker function that will be run when an activity is ready | - -#### Returns - -`void` - -**`Example`** - -```ts -const uploadFile1 = async (ctx) => ctx.uploadFile("./file1.txt", "/file1.txt"); -const uploadFile2 = async (ctx) => ctx.uploadFile("./file2.txt", "/file2.txt"); - -executor.onActivityReady(uploadFile1); -executor.onActivityReady(uploadFile2); - -await executor.run(async (ctx) => { - await ctx.run("cat /file1.txt /file2.txt"); -}); -``` - -#### Defined in - -[src/executor/executor.ts:348](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/executor.ts#L348) - -___ - -### run - -▸ **run**\<`OutputType`\>(`worker`, `options?`): `Promise`\<`OutputType`\> - -Run task - allows to execute a single worker function on the Golem network with a single provider. - -#### Type parameters - -| Name | -| :------ | -| `OutputType` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `worker` | [`Worker`](../modules/task_work#worker)\<`OutputType`\> | function that run task | -| `options?` | [`TaskOptions`](../modules/task_task#taskoptions) | task options | - -#### Returns - -`Promise`\<`OutputType`\> - -result of task computation - -**`Example`** - -```typescript -await executor.run(async (ctx) => console.log((await ctx.run("echo 'Hello World'")).stdout)); -``` - -#### Defined in - -[src/executor/executor.ts:363](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/executor.ts#L363) - -___ - -### cancel - -▸ **cancel**(`reason`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `reason` | `string` | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/executor/executor.ts:414](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/executor.ts#L414) diff --git a/src/pages/docs/golem-js/reference/classes/experimental_golem_network_golem_network.GolemNetwork.md b/src/pages/docs/golem-js/reference/classes/experimental_golem_network_golem_network.GolemNetwork.md new file mode 100644 index 000000000..ab26c5c1f --- /dev/null +++ b/src/pages/docs/golem-js/reference/classes/experimental_golem_network_golem_network.GolemNetwork.md @@ -0,0 +1,140 @@ +--- +title: "Class GolemNetwork" +pageTitle: "Class GolemNetwork - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Class GolemNetwork within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Class: GolemNetwork + +[experimental/golem\_network/golem\_network](../modules/experimental_golem_network_golem_network).GolemNetwork + +This API is experimental and subject to change. Use at your own risk. + +The Golem Network class provides a high-level API for running jobs on the Golem Network. + +## Table of contents + +### Constructors + +- [constructor](experimental_golem_network_golem_network.GolemNetwork#constructor) + +### Methods + +- [isInitialized](experimental_golem_network_golem_network.GolemNetwork#isinitialized) +- [init](experimental_golem_network_golem_network.GolemNetwork#init) +- [createJob](experimental_golem_network_golem_network.GolemNetwork#createjob) +- [getJobById](experimental_golem_network_golem_network.GolemNetwork#getjobbyid) +- [close](experimental_golem_network_golem_network.GolemNetwork#close) + +## Constructors + +### constructor + +• **new GolemNetwork**(`config`): [`GolemNetwork`](experimental_golem_network_golem_network.GolemNetwork) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `config` | [`GolemNetworkConfig`](../modules/experimental_golem_network_golem_network#golemnetworkconfig) | Configuration options that will be passed to all jobs created by this instance. | + +#### Returns + +[`GolemNetwork`](experimental_golem_network_golem_network.GolemNetwork) + +#### Defined in + +[src/experimental/golem_network/golem_network.ts:22](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/golem_network/golem_network.ts#L22) + +## Methods + +### isInitialized + +▸ **isInitialized**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[src/experimental/golem_network/golem_network.ts:24](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/golem_network/golem_network.ts#L24) + +___ + +### init + +▸ **init**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/experimental/golem_network/golem_network.ts:28](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/golem_network/golem_network.ts#L28) + +___ + +### createJob + +▸ **createJob**\<`Output`\>(`options?`): [`Job`](experimental_job_job.Job)\<`Output`\> + +Create a new job and add it to the list of jobs managed by this instance. +This method does not start any work on the network, use [Job.startWork](experimental_job_job.Job#startwork) for that. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Output` | `unknown` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `options` | [`RunJobOptions`](../modules/experimental_job_job#runjoboptions) | Configuration options for the job. These options will be merged with the options passed to the constructor. | + +#### Returns + +[`Job`](experimental_job_job.Job)\<`Output`\> + +#### Defined in + +[src/experimental/golem_network/golem_network.ts:40](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/golem_network/golem_network.ts#L40) + +___ + +### getJobById + +▸ **getJobById**(`id`): `undefined` \| [`Job`](experimental_job_job.Job)\<`unknown`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | + +#### Returns + +`undefined` \| [`Job`](experimental_job_job.Job)\<`unknown`\> + +#### Defined in + +[src/experimental/golem_network/golem_network.ts:50](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/golem_network/golem_network.ts#L50) + +___ + +### close + +▸ **close**(): `Promise`\<`void`\> + +Close the connection to the Yagna service and cancel all running jobs. + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/experimental/golem_network/golem_network.ts:59](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/golem_network/golem_network.ts#L59) diff --git a/src/pages/docs/golem-js/reference/classes/experimental_job_job.Job.md b/src/pages/docs/golem-js/reference/classes/experimental_job_job.Job.md new file mode 100644 index 000000000..575bc622a --- /dev/null +++ b/src/pages/docs/golem-js/reference/classes/experimental_job_job.Job.md @@ -0,0 +1,197 @@ +--- +title: "Class Job" +pageTitle: "Class Job - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Class Job within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Class: Job\ + +[experimental/job/job](../modules/experimental_job_job).Job + +This API is experimental and subject to change. Use at your own risk. + +The Job class represents a single self-contained unit of work that can be run on the Golem Network. +It is responsible for managing the lifecycle of the work and providing information about its state. +It also provides an event emitter that can be used to listen for state changes. + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Output` | `unknown` | + +## Table of contents + +### Constructors + +- [constructor](experimental_job_job.Job#constructor) + +### Properties + +- [events](experimental_job_job.Job#events) +- [results](experimental_job_job.Job#results) +- [error](experimental_job_job.Job#error) +- [state](experimental_job_job.Job#state) +- [id](experimental_job_job.Job#id) + +### Methods + +- [isRunning](experimental_job_job.Job#isrunning) +- [startWork](experimental_job_job.Job#startwork) +- [cancel](experimental_job_job.Job#cancel) +- [waitForResult](experimental_job_job.Job#waitforresult) + +## Constructors + +### constructor + +• **new Job**\<`Output`\>(`id`, `yagnaApi`, `defaultOptions?`): [`Job`](experimental_job_job.Job)\<`Output`\> + +Create a new Job instance. It is recommended to use GolemNetwork to create jobs instead of using this constructor directly. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Output` | `unknown` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `yagnaApi` | [`YagnaApi`](utils_yagna_yagnaApi.YagnaApi) | +| `defaultOptions` | `Partial`\<[`RunJobOptions`](../modules/experimental_job_job#runjoboptions)\> | + +#### Returns + +[`Job`](experimental_job_job.Job)\<`Output`\> + +#### Defined in + +[src/experimental/job/job.ts:87](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L87) + +## Properties + +### events + +• `Readonly` **events**: `EventEmitter`\<[`JobEventsDict`](../interfaces/experimental_job_job.JobEventsDict), `any`\> + +#### Defined in + +[src/experimental/job/job.ts:73](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L73) + +___ + +### results + +• **results**: `undefined` \| `Output` + +#### Defined in + +[src/experimental/job/job.ts:76](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L76) + +___ + +### error + +• **error**: `undefined` \| `Error` + +#### Defined in + +[src/experimental/job/job.ts:77](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L77) + +___ + +### state + +• **state**: [`JobState`](../enums/experimental_job_job.JobState) = `JobState.New` + +#### Defined in + +[src/experimental/job/job.ts:78](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L78) + +___ + +### id + +• `Readonly` **id**: `string` + +#### Defined in + +[src/experimental/job/job.ts:88](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L88) + +## Methods + +### isRunning + +▸ **isRunning**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[src/experimental/job/job.ts:93](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L93) + +___ + +### startWork + +▸ **startWork**(`workOnGolem`, `options?`): `void` + +Run your worker function on the Golem Network. This method will synchronously initialize all internal services and validate the job options. The work itself will be run asynchronously in the background. +You can use the [Job.events](experimental_job_job.Job#events) event emitter to listen for state changes. +You can also use [Job.waitForResult](experimental_job_job.Job#waitforresult) to wait for the job to finish and get the results. +If you want to cancel the job, use [Job.cancel](experimental_job_job.Job#cancel). +If you want to run multiple jobs in parallel, you can use GolemNetwork.createJob to create multiple jobs and run them in parallel. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `workOnGolem` | [`Worker`](../modules/work_work#worker)\<`Output`\> | Your worker function that will be run on the Golem Network. | +| `options` | [`RunJobOptions`](../modules/experimental_job_job#runjoboptions) | Configuration options for the job. These options will be merged with the options passed to the constructor. | + +#### Returns + +`void` + +#### Defined in + +[src/experimental/job/job.ts:109](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L109) + +___ + +### cancel + +▸ **cancel**(): `Promise`\<`void`\> + +Cancel the job. This method will stop the activity and wait for it to finish. +Throws an error if the job is not running. + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/experimental/job/job.ts:252](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L252) + +___ + +### waitForResult + +▸ **waitForResult**(): `Promise`\<`unknown`\> + +Wait for the job to finish and return the results. +Throws an error if the job was not started. + +#### Returns + +`Promise`\<`unknown`\> + +#### Defined in + +[src/experimental/job/job.ts:266](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L266) diff --git a/src/pages/docs/golem-js/reference/classes/experimental_reputation_error.GolemReputationError.md b/src/pages/docs/golem-js/reference/classes/experimental_reputation_error.GolemReputationError.md new file mode 100644 index 000000000..06986d63d --- /dev/null +++ b/src/pages/docs/golem-js/reference/classes/experimental_reputation_error.GolemReputationError.md @@ -0,0 +1,85 @@ +--- +title: "Class GolemReputationError" +pageTitle: "Class GolemReputationError - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Class GolemReputationError within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Class: GolemReputationError + +[experimental/reputation/error](../modules/experimental_reputation_error).GolemReputationError + +Module specific errors - Market, Work, Payment. +Each of the major modules will have its own domain specific root error type, +additionally containing an error code specific to a given subdomain + +## Hierarchy + +- [`GolemModuleError`](error_golem_error.GolemModuleError) + + ↳ **`GolemReputationError`** + +## Table of contents + +### Constructors + +- [constructor](experimental_reputation_error.GolemReputationError#constructor) + +### Properties + +- [code](experimental_reputation_error.GolemReputationError#code) +- [previous](experimental_reputation_error.GolemReputationError#previous) + +## Constructors + +### constructor + +• **new GolemReputationError**(`message`, `cause?`): [`GolemReputationError`](experimental_reputation_error.GolemReputationError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `cause?` | `Error` | + +#### Returns + +[`GolemReputationError`](experimental_reputation_error.GolemReputationError) + +#### Overrides + +[GolemModuleError](error_golem_error.GolemModuleError).[constructor](error_golem_error.GolemModuleError#constructor) + +#### Defined in + +[src/experimental/reputation/error.ts:4](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/error.ts#L4) + +## Properties + +### code + +• **code**: `string` \| `number` + +#### Inherited from + +[GolemModuleError](error_golem_error.GolemModuleError).[code](error_golem_error.GolemModuleError#code) + +#### Defined in + +[src/error/golem-error.ts:66](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/error/golem-error.ts#L66) + +___ + +### previous + +• `Optional` `Readonly` **previous**: `Error` + +The previous error, if any, that led to this error. + +#### Inherited from + +[GolemModuleError](error_golem_error.GolemModuleError).[previous](error_golem_error.GolemModuleError#previous) + +#### Defined in + +[src/error/golem-error.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/error/golem-error.ts#L10) diff --git a/src/pages/docs/golem-js/reference/classes/experimental_reputation_system.ReputationSystem.md b/src/pages/docs/golem-js/reference/classes/experimental_reputation_system.ReputationSystem.md new file mode 100644 index 000000000..afa45d7ec --- /dev/null +++ b/src/pages/docs/golem-js/reference/classes/experimental_reputation_system.ReputationSystem.md @@ -0,0 +1,356 @@ +--- +title: "Class ReputationSystem" +pageTitle: "Class ReputationSystem - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Class ReputationSystem within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Class: ReputationSystem + +[experimental/reputation/system](../modules/experimental_reputation_system).ReputationSystem + +Reputation system client. + +This class is responsible for fetching and applying reputation data to Golem SDK's market management class. + +Currently, it includes a proposal filter you can use to filter out providers with low reputation scores. + +Reputation data is gathered by the following project: https://github.com/golemfactory/reputation-auditor + +You can adjust the weights used to calculate the score for proposals by using the `setProposalWeights` method. + +NOTE: This class is currently experimental and subject to change. + +NOTE: Only providers from polygon network are being tested, so using this class on testnet will not work. + +## Table of contents + +### Constructors + +- [constructor](experimental_reputation_system.ReputationSystem#constructor) + +### Properties + +- [paymentNetwork](experimental_reputation_system.ReputationSystem#paymentnetwork) + +### Methods + +- [create](experimental_reputation_system.ReputationSystem#create) +- [setData](experimental_reputation_system.ReputationSystem#setdata) +- [getData](experimental_reputation_system.ReputationSystem#getdata) +- [fetchData](experimental_reputation_system.ReputationSystem#fetchdata) +- [setProposalWeights](experimental_reputation_system.ReputationSystem#setproposalweights) +- [getProposalWeights](experimental_reputation_system.ReputationSystem#getproposalweights) +- [setAgreementWeights](experimental_reputation_system.ReputationSystem#setagreementweights) +- [getAgreementWeights](experimental_reputation_system.ReputationSystem#getagreementweights) +- [getProviderScores](experimental_reputation_system.ReputationSystem#getproviderscores) +- [proposalFilter](experimental_reputation_system.ReputationSystem#proposalfilter) +- [agreementSelector](experimental_reputation_system.ReputationSystem#agreementselector) +- [calculateScore](experimental_reputation_system.ReputationSystem#calculatescore) +- [calculateProviderPool](experimental_reputation_system.ReputationSystem#calculateproviderpool) + +## Constructors + +### constructor + +• **new ReputationSystem**(`config?`): [`ReputationSystem`](experimental_reputation_system.ReputationSystem) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config?` | [`ReputationConfig`](../interfaces/experimental_reputation_types.ReputationConfig) | + +#### Returns + +[`ReputationSystem`](experimental_reputation_system.ReputationSystem) + +#### Defined in + +[src/experimental/reputation/system.ts:132](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L132) + +## Properties + +### paymentNetwork + +• `Readonly` **paymentNetwork**: `string` + +The payment network currently used. + +#### Defined in + +[src/experimental/reputation/system.ts:93](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L93) + +## Methods + +### create + +▸ **create**(`config?`): `Promise`\<[`ReputationSystem`](experimental_reputation_system.ReputationSystem)\> + +Create a new reputation system client and fetch the reputation data. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config?` | [`ReputationConfig`](../interfaces/experimental_reputation_types.ReputationConfig) | + +#### Returns + +`Promise`\<[`ReputationSystem`](experimental_reputation_system.ReputationSystem)\> + +#### Defined in + +[src/experimental/reputation/system.ts:126](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L126) + +___ + +### setData + +▸ **setData**(`data`): `void` + +Set reputation data. + +This is useful if you want to cache the date locally, or you have an alternative source of data. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`ReputationData`](../interfaces/experimental_reputation_types.ReputationData) | + +#### Returns + +`void` + +#### Defined in + +[src/experimental/reputation/system.ts:143](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L143) + +___ + +### getData + +▸ **getData**(): [`ReputationData`](../interfaces/experimental_reputation_types.ReputationData) + +Returns current reputation data. + +#### Returns + +[`ReputationData`](../interfaces/experimental_reputation_types.ReputationData) + +#### Defined in + +[src/experimental/reputation/system.ts:165](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L165) + +___ + +### fetchData + +▸ **fetchData**(): `Promise`\<`void`\> + +Fetch data from the reputation service. + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/experimental/reputation/system.ts:172](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L172) + +___ + +### setProposalWeights + +▸ **setProposalWeights**(`weights`): `void` + +Set weights used to calculate the score for proposals. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `weights` | `Partial`\<[`ReputationProviderScores`](../interfaces/experimental_reputation_types.ReputationProviderScores)\> | + +#### Returns + +`void` + +#### Defined in + +[src/experimental/reputation/system.ts:199](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L199) + +___ + +### getProposalWeights + +▸ **getProposalWeights**(): `Partial`\<[`ReputationProviderScores`](../interfaces/experimental_reputation_types.ReputationProviderScores)\> + +Returns current proposal weights. + +#### Returns + +`Partial`\<[`ReputationProviderScores`](../interfaces/experimental_reputation_types.ReputationProviderScores)\> + +#### Defined in + +[src/experimental/reputation/system.ts:206](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L206) + +___ + +### setAgreementWeights + +▸ **setAgreementWeights**(`weights`): `void` + +Set weights used to calculate the score for agreements. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `weights` | `Partial`\<[`ReputationProviderScores`](../interfaces/experimental_reputation_types.ReputationProviderScores)\> | + +#### Returns + +`void` + +#### Defined in + +[src/experimental/reputation/system.ts:213](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L213) + +___ + +### getAgreementWeights + +▸ **getAgreementWeights**(): `Partial`\<[`ReputationProviderScores`](../interfaces/experimental_reputation_types.ReputationProviderScores)\> + +Returns current agreement weights. + +#### Returns + +`Partial`\<[`ReputationProviderScores`](../interfaces/experimental_reputation_types.ReputationProviderScores)\> + +#### Defined in + +[src/experimental/reputation/system.ts:220](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L220) + +___ + +### getProviderScores + +▸ **getProviderScores**(`providerId`): `undefined` \| [`ReputationProviderScores`](../interfaces/experimental_reputation_types.ReputationProviderScores) + +Returns scores for a provider or undefined if the provider is unlisted. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `providerId` | `string` | + +#### Returns + +`undefined` \| [`ReputationProviderScores`](../interfaces/experimental_reputation_types.ReputationProviderScores) + +#### Defined in + +[src/experimental/reputation/system.ts:228](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L228) + +___ + +### proposalFilter + +▸ **proposalFilter**(`opts?`): [`ProposalFilter`](../modules/market_service#proposalfilter) + +Returns a proposal filter that can be used to filter out providers with low reputation scores. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts?` | [`ProposalFilterOptions`](../interfaces/experimental_reputation_types.ProposalFilterOptions) | + +#### Returns + +[`ProposalFilter`](../modules/market_service#proposalfilter) + +#### Defined in + +[src/experimental/reputation/system.ts:236](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L236) + +___ + +### agreementSelector + +▸ **agreementSelector**(`opts?`): [`AgreementSelector`](../modules/agreement_service#agreementselector) + +Returns an agreement selector that can be used to select providers based on their reputation scores. + +The outcome of this function is determined by current provider scores and the agreement weights set. + +For best results, make sure you test the performance or stability of your workload using different weights. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts?` | [`AgreementSelectorOption`](../interfaces/experimental_reputation_types.AgreementSelectorOption) | + +#### Returns + +[`AgreementSelector`](../modules/agreement_service#agreementselector) + +**`See`** + +setAgreementWeights + +#### Defined in + +[src/experimental/reputation/system.ts:296](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L296) + +___ + +### calculateScore + +▸ **calculateScore**(`scores`, `weights`): `number` + +Calculate a normalized score based on the given scores and weights. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `scores` | `Partial`\<[`ReputationProviderScores`](../interfaces/experimental_reputation_types.ReputationProviderScores)\> | +| `weights` | `Partial`\<[`ReputationProviderScores`](../interfaces/experimental_reputation_types.ReputationProviderScores)\> | + +#### Returns + +`number` + +#### Defined in + +[src/experimental/reputation/system.ts:337](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L337) + +___ + +### calculateProviderPool + +▸ **calculateProviderPool**(`opts?`): [`ReputationProviderEntry`](../interfaces/experimental_reputation_types.ReputationProviderEntry)[] + +Based on the current reputation data, calculate a list of providers that meet the minimum score requirement. + +This method is useful to validate you filter and weights vs the available provider market. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `opts?` | [`ProposalFilterOptions`](../interfaces/experimental_reputation_types.ProposalFilterOptions) | + +#### Returns + +[`ReputationProviderEntry`](../interfaces/experimental_reputation_types.ReputationProviderEntry)[] + +#### Defined in + +[src/experimental/reputation/system.ts:360](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L360) diff --git a/src/pages/docs/golem-js/reference/classes/golem_network_golem_network.GolemNetwork.md b/src/pages/docs/golem-js/reference/classes/golem_network_golem_network.GolemNetwork.md deleted file mode 100644 index fab657563..000000000 --- a/src/pages/docs/golem-js/reference/classes/golem_network_golem_network.GolemNetwork.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -title: "Class GolemNetwork" -pageTitle: "Class GolemNetwork - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class GolemNetwork within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: GolemNetwork - -[golem\_network/golem\_network](../modules/golem_network_golem_network).GolemNetwork - -This API is experimental and subject to change. Use at your own risk. - -The Golem Network class provides a high-level API for running jobs on the Golem Network. - -## Table of contents - -### Constructors - -- [constructor](golem_network_golem_network.GolemNetwork#constructor) - -### Methods - -- [isInitialized](golem_network_golem_network.GolemNetwork#isinitialized) -- [init](golem_network_golem_network.GolemNetwork#init) -- [createJob](golem_network_golem_network.GolemNetwork#createjob) -- [getJobById](golem_network_golem_network.GolemNetwork#getjobbyid) -- [close](golem_network_golem_network.GolemNetwork#close) - -## Constructors - -### constructor - -• **new GolemNetwork**(`config`): [`GolemNetwork`](golem_network_golem_network.GolemNetwork) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `config` | [`GolemNetworkConfig`](../modules/golem_network_golem_network#golemnetworkconfig) | Configuration options that will be passed to all jobs created by this instance. | - -#### Returns - -[`GolemNetwork`](golem_network_golem_network.GolemNetwork) - -#### Defined in - -[src/golem_network/golem_network.ts:24](https://github.com/golemfactory/golem-js/blob/7cee55b/src/golem_network/golem_network.ts#L24) - -## Methods - -### isInitialized - -▸ **isInitialized**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/golem_network/golem_network.ts:28](https://github.com/golemfactory/golem-js/blob/7cee55b/src/golem_network/golem_network.ts#L28) - -___ - -### init - -▸ **init**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/golem_network/golem_network.ts:32](https://github.com/golemfactory/golem-js/blob/7cee55b/src/golem_network/golem_network.ts#L32) - -___ - -### createJob - -▸ **createJob**\<`Output`\>(`options?`): [`Job`](job_job.Job)\<`Output`\> - -Create a new job and add it to the list of jobs managed by this instance. -This method does not start any work on the network, use [Job.startWork](job_job.Job#startwork) for that. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Output` | `unknown` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options` | [`RunJobOptions`](../modules/job_job#runjoboptions) | Configuration options for the job. These options will be merged with the options passed to the constructor. | - -#### Returns - -[`Job`](job_job.Job)\<`Output`\> - -#### Defined in - -[src/golem_network/golem_network.ts:43](https://github.com/golemfactory/golem-js/blob/7cee55b/src/golem_network/golem_network.ts#L43) - -___ - -### getJobById - -▸ **getJobById**(`id`): `undefined` \| [`Job`](job_job.Job)\<`unknown`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Returns - -`undefined` \| [`Job`](job_job.Job)\<`unknown`\> - -#### Defined in - -[src/golem_network/golem_network.ts:53](https://github.com/golemfactory/golem-js/blob/7cee55b/src/golem_network/golem_network.ts#L53) - -___ - -### close - -▸ **close**(): `Promise`\<`void`\> - -Close the connection to the Yagna service and cancel all running jobs. - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/golem_network/golem_network.ts:62](https://github.com/golemfactory/golem-js/blob/7cee55b/src/golem_network/golem_network.ts#L62) diff --git a/src/pages/docs/golem-js/reference/classes/gvmi_gvmiServer.GvmiServer.md b/src/pages/docs/golem-js/reference/classes/gvmi_gvmiServer.GvmiServer.md new file mode 100644 index 000000000..89f916309 --- /dev/null +++ b/src/pages/docs/golem-js/reference/classes/gvmi_gvmiServer.GvmiServer.md @@ -0,0 +1,137 @@ +--- +title: "Class GvmiServer" +pageTitle: "Class GvmiServer - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Class GvmiServer within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Class: GvmiServer + +[gvmi/gvmiServer](../modules/gvmi_gvmiServer).GvmiServer + +Helper class to serve a local gvmi file so a provider can +download it directly from you. When you start serving the file, +the server will calculate the hash automatically. + +## Table of contents + +### Constructors + +- [constructor](gvmi_gvmiServer.GvmiServer#constructor) + +### Properties + +- [fileHash](gvmi_gvmiServer.GvmiServer#filehash) + +### Methods + +- [calculateFileHash](gvmi_gvmiServer.GvmiServer#calculatefilehash) +- [isServing](gvmi_gvmiServer.GvmiServer#isserving) +- [serve](gvmi_gvmiServer.GvmiServer#serve) +- [close](gvmi_gvmiServer.GvmiServer#close) +- [getImage](gvmi_gvmiServer.GvmiServer#getimage) + +## Constructors + +### constructor + +• **new GvmiServer**(`gvmiPath`, `storageProvider?`): [`GvmiServer`](gvmi_gvmiServer.GvmiServer) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `gvmiPath` | `string` | +| `storageProvider?` | [`StorageProvider`](../interfaces/storage_provider.StorageProvider) | + +#### Returns + +[`GvmiServer`](gvmi_gvmiServer.GvmiServer) + +#### Defined in + +[src/gvmi/gvmiServer.ts:17](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/gvmi/gvmiServer.ts#L17) + +## Properties + +### fileHash + +• `Readonly` **fileHash**: `string` + +#### Defined in + +[src/gvmi/gvmiServer.ts:14](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/gvmi/gvmiServer.ts#L14) + +## Methods + +### calculateFileHash + +▸ **calculateFileHash**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/gvmi/gvmiServer.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/gvmi/gvmiServer.ts#L27) + +___ + +### isServing + +▸ **isServing**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +[src/gvmi/gvmiServer.ts:32](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/gvmi/gvmiServer.ts#L32) + +___ + +### serve + +▸ **serve**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/gvmi/gvmiServer.ts:36](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/gvmi/gvmiServer.ts#L36) + +___ + +### close + +▸ **close**(): `Promise`\<`void`\> + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/gvmi/gvmiServer.ts:44](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/gvmi/gvmiServer.ts#L44) + +___ + +### getImage + +▸ **getImage**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `hash` | `string` | + +#### Defined in + +[src/gvmi/gvmiServer.ts:48](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/gvmi/gvmiServer.ts#L48) diff --git a/src/pages/docs/golem-js/reference/classes/job_job.Job.md b/src/pages/docs/golem-js/reference/classes/job_job.Job.md deleted file mode 100644 index 6e17bba11..000000000 --- a/src/pages/docs/golem-js/reference/classes/job_job.Job.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -title: "Class Job" -pageTitle: "Class Job - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class Job within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: Job\ - -[job/job](../modules/job_job).Job - -This API is experimental and subject to change. Use at your own risk. - -The Job class represents a single self-contained unit of work that can be run on the Golem Network. -It is responsible for managing the lifecycle of the work and providing information about its state. -It also provides an event emitter that can be used to listen for state changes. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `Output` | `unknown` | - -## Table of contents - -### Constructors - -- [constructor](job_job.Job#constructor) - -### Properties - -- [events](job_job.Job#events) -- [results](job_job.Job#results) -- [error](job_job.Job#error) -- [state](job_job.Job#state) -- [id](job_job.Job#id) - -### Methods - -- [isRunning](job_job.Job#isrunning) -- [startWork](job_job.Job#startwork) -- [cancel](job_job.Job#cancel) -- [waitForResult](job_job.Job#waitforresult) - -## Constructors - -### constructor - -• **new Job**\<`Output`\>(`id`, `yagnaApi`, `defaultOptions?`): [`Job`](job_job.Job)\<`Output`\> - -Create a new Job instance. It is recommended to use GolemNetwork to create jobs instead of using this constructor directly. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Output` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `yagnaApi` | [`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi) | -| `defaultOptions` | `Partial`\<[`RunJobOptions`](../modules/job_job#runjoboptions)\> | - -#### Returns - -[`Job`](job_job.Job)\<`Output`\> - -#### Defined in - -[src/job/job.ts:76](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L76) - -## Properties - -### events - -• `Readonly` **events**: `EventEmitter`\<[`JobEventsDict`](../interfaces/job_job.JobEventsDict), `any`\> - -#### Defined in - -[src/job/job.ts:62](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L62) - -___ - -### results - -• **results**: `undefined` \| `Output` - -#### Defined in - -[src/job/job.ts:65](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L65) - -___ - -### error - -• **error**: `undefined` \| `Error` - -#### Defined in - -[src/job/job.ts:66](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L66) - -___ - -### state - -• **state**: [`TaskState`](../enums/task_task.TaskState) = `JobState.New` - -#### Defined in - -[src/job/job.ts:67](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L67) - -___ - -### id - -• `Readonly` **id**: `string` - -#### Defined in - -[src/job/job.ts:77](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L77) - -## Methods - -### isRunning - -▸ **isRunning**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/job/job.ts:82](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L82) - -___ - -### startWork - -▸ **startWork**(`workOnGolem`, `options?`): `void` - -Run your worker function on the Golem Network. This method will synchronously initialize all internal services and validate the job options. The work itself will be run asynchronously in the background. -You can use the [Job.events](job_job.Job#events) event emitter to listen for state changes. -You can also use [Job.waitForResult](job_job.Job#waitforresult) to wait for the job to finish and get the results. -If you want to cancel the job, use [Job.cancel](job_job.Job#cancel). -If you want to run multiple jobs in parallel, you can use GolemNetwork.createJob to create multiple jobs and run them in parallel. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `workOnGolem` | [`Worker`](../modules/task_work#worker)\<`Output`\> | Your worker function that will be run on the Golem Network. | -| `options` | [`RunJobOptions`](../modules/job_job#runjoboptions) | Configuration options for the job. These options will be merged with the options passed to the constructor. | - -#### Returns - -`void` - -#### Defined in - -[src/job/job.ts:98](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L98) - -___ - -### cancel - -▸ **cancel**(): `Promise`\<`void`\> - -Cancel the job. This method will stop the activity and wait for it to finish. -Throws an error if the job is not running. - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/job/job.ts:235](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L235) - -___ - -### waitForResult - -▸ **waitForResult**(): `Promise`\<`unknown`\> - -Wait for the job to finish and return the results. -Throws an error if the job was not started. - -#### Returns - -`Promise`\<`unknown`\> - -#### Defined in - -[src/job/job.ts:249](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L249) diff --git a/src/pages/docs/golem-js/reference/classes/market_error.GolemMarketError.md b/src/pages/docs/golem-js/reference/classes/market_error.GolemMarketError.md index ae626acb4..90bb7a79f 100644 --- a/src/pages/docs/golem-js/reference/classes/market_error.GolemMarketError.md +++ b/src/pages/docs/golem-js/reference/classes/market_error.GolemMarketError.md @@ -27,9 +27,12 @@ additionally containing an error code specific to a given subdomain ### Properties - [code](market_error.GolemMarketError#code) -- [demand](market_error.GolemMarketError#demand) - [previous](market_error.GolemMarketError#previous) +### Methods + +- [getDemand](market_error.GolemMarketError#getdemand) + ## Constructors ### constructor @@ -55,7 +58,7 @@ additionally containing an error code specific to a given subdomain #### Defined in -[src/market/error.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L18) +[src/market/error.ts:19](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L19) ## Properties @@ -69,17 +72,7 @@ additionally containing an error code specific to a given subdomain #### Defined in -[src/market/error.ts:20](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L20) - -___ - -### demand - -• `Optional` **demand**: `Demand` - -#### Defined in - -[src/market/error.ts:21](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L21) +[src/market/error.ts:21](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L21) ___ @@ -95,4 +88,18 @@ The previous error, if any, that led to this error. #### Defined in -[src/market/error.ts:22](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L22) +[src/market/error.ts:23](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L23) + +## Methods + +### getDemand + +▸ **getDemand**(): `undefined` \| `Demand` + +#### Returns + +`undefined` \| `Demand` + +#### Defined in + +[src/market/error.ts:28](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L28) diff --git a/src/pages/docs/golem-js/reference/classes/market_proposal.Proposal.md b/src/pages/docs/golem-js/reference/classes/market_proposal.Proposal.md index ab2dbb21e..076d8dcdf 100644 --- a/src/pages/docs/golem-js/reference/classes/market_proposal.Proposal.md +++ b/src/pages/docs/golem-js/reference/classes/market_proposal.Proposal.md @@ -25,6 +25,7 @@ Proposal module - an object representing an offer in the state of a proposal fro - [constraints](market_proposal.Proposal#constraints) - [timestamp](market_proposal.Proposal#timestamp) - [counteringProposalId](market_proposal.Proposal#counteringproposalid) +- [events](market_proposal.Proposal#events) - [demand](market_proposal.Proposal#demand) ### Accessors @@ -48,7 +49,7 @@ Proposal module - an object representing an offer in the state of a proposal fro ### constructor -• **new Proposal**(`demand`, `parentId`, `setCounteringProposalReference`, `api`, `model`, `eventTarget?`): [`Proposal`](market_proposal.Proposal) +• **new Proposal**(`demand`, `parentId`, `setCounteringProposalReference`, `api`, `model`): [`Proposal`](market_proposal.Proposal) Create proposal for given subscription ID @@ -59,9 +60,8 @@ Create proposal for given subscription ID | `demand` | `Demand` | | `parentId` | ``null`` \| `string` | | `setCounteringProposalReference` | (`id`: `string`, `parentId`: `string`) => ``null`` \| `void` | -| `api` | `RequestorApi` | +| `api` | `RequestorService` | | `model` | `Proposal` | -| `eventTarget?` | `EventTarget` | #### Returns @@ -69,7 +69,7 @@ Create proposal for given subscription ID #### Defined in -[src/market/proposal.ts:84](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L84) +[src/market/proposal.ts:90](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L90) ## Properties @@ -79,7 +79,7 @@ Create proposal for given subscription ID #### Defined in -[src/market/proposal.ts:64](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L64) +[src/market/proposal.ts:70](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L70) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -[src/market/proposal.ts:65](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L65) +[src/market/proposal.ts:71](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L71) ___ @@ -99,7 +99,7 @@ ___ #### Defined in -[src/market/proposal.ts:66](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L66) +[src/market/proposal.ts:72](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L72) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -[src/market/proposal.ts:67](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L67) +[src/market/proposal.ts:73](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L73) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[src/market/proposal.ts:68](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L68) +[src/market/proposal.ts:74](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L74) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -[src/market/proposal.ts:69](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L69) +[src/market/proposal.ts:75](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L75) ___ @@ -139,7 +139,17 @@ ___ #### Defined in -[src/market/proposal.ts:70](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L70) +[src/market/proposal.ts:76](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L76) + +___ + +### events + +• `Readonly` **events**: `EventEmitter`\<[`ProposalEvents`](../interfaces/market_proposal.ProposalEvents), `any`\> + +#### Defined in + +[src/market/proposal.ts:79](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L79) ___ @@ -149,7 +159,7 @@ ___ #### Defined in -[src/market/proposal.ts:85](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L85) +[src/market/proposal.ts:91](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L91) ## Accessors @@ -163,7 +173,7 @@ ___ #### Defined in -[src/market/proposal.ts:106](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L106) +[src/market/proposal.ts:111](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L111) ___ @@ -177,7 +187,7 @@ ___ #### Defined in -[src/market/proposal.ts:122](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L122) +[src/market/proposal.ts:127](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L127) ## Methods @@ -195,7 +205,7 @@ Use this method before executing any important logic, to ensure that you're work #### Defined in -[src/market/proposal.ts:145](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L145) +[src/market/proposal.ts:150](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L150) ___ @@ -209,7 +219,7 @@ ___ #### Defined in -[src/market/proposal.ts:182](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L182) +[src/market/proposal.ts:187](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L187) ___ @@ -223,7 +233,7 @@ ___ #### Defined in -[src/market/proposal.ts:186](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L186) +[src/market/proposal.ts:191](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L191) ___ @@ -237,7 +247,7 @@ ___ #### Defined in -[src/market/proposal.ts:190](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L190) +[src/market/proposal.ts:195](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L195) ___ @@ -251,7 +261,7 @@ ___ #### Defined in -[src/market/proposal.ts:194](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L194) +[src/market/proposal.ts:199](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L199) ___ @@ -271,7 +281,7 @@ ___ #### Defined in -[src/market/proposal.ts:198](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L198) +[src/market/proposal.ts:203](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L203) ___ @@ -291,7 +301,7 @@ ___ #### Defined in -[src/market/proposal.ts:220](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L220) +[src/market/proposal.ts:223](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L223) ___ @@ -311,7 +321,7 @@ ___ #### Defined in -[src/market/proposal.ts:260](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L260) +[src/market/proposal.ts:266](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L266) ___ @@ -327,4 +337,4 @@ Proposal cost estimation based on CPU, Env and startup costs #### Defined in -[src/market/proposal.ts:267](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L267) +[src/market/proposal.ts:273](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L273) diff --git a/src/pages/docs/golem-js/reference/classes/market_proposals_batch.ProposalsBatch.md b/src/pages/docs/golem-js/reference/classes/market_proposals_batch.ProposalsBatch.md index f8e47a4a2..d15b09542 100644 --- a/src/pages/docs/golem-js/reference/classes/market_proposals_batch.ProposalsBatch.md +++ b/src/pages/docs/golem-js/reference/classes/market_proposals_batch.ProposalsBatch.md @@ -20,7 +20,8 @@ to avoid duplicate offers issued by the provider. ### Methods - [addProposal](market_proposals_batch.ProposalsBatch#addproposal) -- [readProposals](market_proposals_batch.ProposalsBatch#readproposals) +- [getProposals](market_proposals_batch.ProposalsBatch#getproposals) +- [waitForProposals](market_proposals_batch.ProposalsBatch#waitforproposals) ## Constructors @@ -40,7 +41,7 @@ to avoid duplicate offers issued by the provider. #### Defined in -[src/market/proposals_batch.ts:27](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposals_batch.ts#L27) +[src/market/proposals_batch.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposals_batch.ts#L27) ## Methods @@ -63,21 +64,39 @@ which consist of providerId, cores, threads, mem and storage #### Defined in -[src/market/proposals_batch.ts:38](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposals_batch.ts#L38) +[src/market/proposals_batch.ts:38](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposals_batch.ts#L38) ___ -### readProposals +### getProposals -▸ **readProposals**(): `AsyncGenerator`\<[`Proposal`](market_proposal.Proposal)[], `any`, `unknown`\> +▸ **getProposals**(): `Promise`\<[`Proposal`](market_proposal.Proposal)[]\> -Generates a set of proposals that were collected within the specified `releaseTimeoutMs` -or their size reached the `minBatchSize` value +Returns the batched proposals from the internal buffer and empties it #### Returns -`AsyncGenerator`\<[`Proposal`](market_proposal.Proposal)[], `any`, `unknown`\> +`Promise`\<[`Proposal`](market_proposal.Proposal)[]\> #### Defined in -[src/market/proposals_batch.ts:54](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposals_batch.ts#L54) +[src/market/proposals_batch.ts:53](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposals_batch.ts#L53) + +___ + +### waitForProposals + +▸ **waitForProposals**(): `Promise`\<`void`\> + +Waits for the max amount time for batching or max batch size to be reached before it makes sense to process events + +Used to flow-control the consumption of the proposal events from the batch. +The returned promise resolves when it is time to process the buffered proposal events. + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/market/proposals_batch.ts:70](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposals_batch.ts#L70) diff --git a/src/pages/docs/golem-js/reference/classes/network_error.GolemNetworkError.md b/src/pages/docs/golem-js/reference/classes/network_error.GolemNetworkError.md index 28d4e0fc9..4784448a0 100644 --- a/src/pages/docs/golem-js/reference/classes/network_error.GolemNetworkError.md +++ b/src/pages/docs/golem-js/reference/classes/network_error.GolemNetworkError.md @@ -27,9 +27,12 @@ additionally containing an error code specific to a given subdomain ### Properties - [code](network_error.GolemNetworkError#code) -- [network](network_error.GolemNetworkError#network) - [previous](network_error.GolemNetworkError#previous) +### Methods + +- [getNetwork](network_error.GolemNetworkError#getnetwork) + ## Constructors ### constructor @@ -55,7 +58,7 @@ additionally containing an error code specific to a given subdomain #### Defined in -[src/network/error.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/error.ts#L17) +[src/network/error.ts:18](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/error.ts#L18) ## Properties @@ -69,17 +72,7 @@ additionally containing an error code specific to a given subdomain #### Defined in -[src/network/error.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/error.ts#L19) - -___ - -### network - -• `Optional` **network**: [`NetworkInfo`](../interfaces/network_network.NetworkInfo) - -#### Defined in - -[src/network/error.ts:20](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/error.ts#L20) +[src/network/error.ts:20](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/error.ts#L20) ___ @@ -95,4 +88,18 @@ The previous error, if any, that led to this error. #### Defined in -[src/network/error.ts:21](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/error.ts#L21) +[src/network/error.ts:22](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/error.ts#L22) + +## Methods + +### getNetwork + +▸ **getNetwork**(): `undefined` \| [`NetworkInfo`](../interfaces/network_network.NetworkInfo) + +#### Returns + +`undefined` \| [`NetworkInfo`](../interfaces/network_network.NetworkInfo) + +#### Defined in + +[src/network/error.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/error.ts#L27) diff --git a/src/pages/docs/golem-js/reference/classes/network_node.NetworkNode.md b/src/pages/docs/golem-js/reference/classes/network_node.NetworkNode.md index b830e8bb0..e84138094 100644 --- a/src/pages/docs/golem-js/reference/classes/network_node.NetworkNode.md +++ b/src/pages/docs/golem-js/reference/classes/network_node.NetworkNode.md @@ -47,7 +47,7 @@ Describes a node in a VPN, mapping a Golem node id to an IP address #### Defined in -[src/network/node.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/node.ts#L8) +[src/network/node.ts:8](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/node.ts#L8) ## Properties @@ -57,7 +57,7 @@ Describes a node in a VPN, mapping a Golem node id to an IP address #### Defined in -[src/network/node.ts:9](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/node.ts#L9) +[src/network/node.ts:9](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/node.ts#L9) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[src/network/node.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/node.ts#L10) +[src/network/node.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/node.ts#L10) ## Methods @@ -89,7 +89,7 @@ on the provider's end. #### Defined in -[src/network/node.ts:20](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/node.ts#L20) +[src/network/node.ts:20](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/node.ts#L20) ___ @@ -113,4 +113,4 @@ the url #### Defined in -[src/network/node.ts:36](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/node.ts#L36) +[src/network/node.ts:36](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/node.ts#L36) diff --git a/src/pages/docs/golem-js/reference/classes/network_tcpProxy.TcpProxy.md b/src/pages/docs/golem-js/reference/classes/network_tcpProxy.TcpProxy.md new file mode 100644 index 000000000..c45eb3a07 --- /dev/null +++ b/src/pages/docs/golem-js/reference/classes/network_tcpProxy.TcpProxy.md @@ -0,0 +1,101 @@ +--- +title: "Class TcpProxy" +pageTitle: "Class TcpProxy - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Class TcpProxy within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Class: TcpProxy + +[network/tcpProxy](../modules/network_tcpProxy).TcpProxy + +Allows proxying of TCP traffic to a service running in an activity on a provider via the requestor + +**IMPORTANT** + +This feature is supported only in the Node.js environment. In has no effect in browsers. + +## Table of contents + +### Constructors + +- [constructor](network_tcpProxy.TcpProxy#constructor) + +### Properties + +- [events](network_tcpProxy.TcpProxy#events) + +### Methods + +- [listen](network_tcpProxy.TcpProxy#listen) +- [close](network_tcpProxy.TcpProxy#close) + +## Constructors + +### constructor + +• **new TcpProxy**(`wsUrl`, `appKey`, `options`): [`TcpProxy`](network_tcpProxy.TcpProxy) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `wsUrl` | `string` | The URL to the WebSocket implementing the communication transport layer | +| `appKey` | `string` | The yagna app-key used to authenticate the WebSocket connection | +| `options` | `Partial`\<`TcpProxyOptions`\> | Additional options of the proxy | + +#### Returns + +[`TcpProxy`](network_tcpProxy.TcpProxy) + +#### Defined in + +[src/network/tcpProxy.ts:44](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/tcpProxy.ts#L44) + +## Properties + +### events + +• `Readonly` **events**: `EventEmitter`\<`TcpProxyEvents`, `any`\> + +#### Defined in + +[src/network/tcpProxy.ts:38](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/tcpProxy.ts#L38) + +## Methods + +### listen + +▸ **listen**(`port`, `abort?`): `Promise`\<`void`\> + +Start the proxy in listening mode + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `port` | `number` | The port number to use on the requestor | +| `abort?` | `AbortController` | The abort controller to use in order to control cancelling requests | + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/network/tcpProxy.ts:134](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/tcpProxy.ts#L134) + +___ + +### close + +▸ **close**(): `Promise`\<`void`\> + +Gracefully close the proxy + +#### Returns + +`Promise`\<`void`\> + +#### Defined in + +[src/network/tcpProxy.ts:163](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/tcpProxy.ts#L163) diff --git a/src/pages/docs/golem-js/reference/classes/package_package.Package.md b/src/pages/docs/golem-js/reference/classes/package_package.Package.md index 78e86a8b1..9228cefa0 100644 --- a/src/pages/docs/golem-js/reference/classes/package_package.Package.md +++ b/src/pages/docs/golem-js/reference/classes/package_package.Package.md @@ -34,7 +34,7 @@ Package module - an object for descriptions of the payload required by the reque #### Defined in -[src/package/package.ts:138](https://github.com/golemfactory/golem-js/blob/7cee55b/src/package/package.ts#L138) +[src/package/package.ts:162](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/package/package.ts#L162) ## Methods @@ -54,7 +54,7 @@ Package module - an object for descriptions of the payload required by the reque #### Defined in -[src/package/package.ts:56](https://github.com/golemfactory/golem-js/blob/7cee55b/src/package/package.ts#L56) +[src/package/package.ts:62](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/package/package.ts#L62) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[src/package/package.ts:62](https://github.com/golemfactory/golem-js/blob/7cee55b/src/package/package.ts#L62) +[src/package/package.ts:68](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/package/package.ts#L68) ___ @@ -88,4 +88,4 @@ ___ #### Defined in -[src/package/package.ts:77](https://github.com/golemfactory/golem-js/blob/7cee55b/src/package/package.ts#L77) +[src/package/package.ts:83](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/package/package.ts#L83) diff --git a/src/pages/docs/golem-js/reference/classes/payment_InvoiceProcessor.InvoiceProcessor.md b/src/pages/docs/golem-js/reference/classes/payment_InvoiceProcessor.InvoiceProcessor.md index 4a6eca30d..215c1a1bb 100644 --- a/src/pages/docs/golem-js/reference/classes/payment_InvoiceProcessor.InvoiceProcessor.md +++ b/src/pages/docs/golem-js/reference/classes/payment_InvoiceProcessor.InvoiceProcessor.md @@ -32,7 +32,7 @@ Creates an instance of `InvoiceProcessor` and connects to the Yagna API. | Name | Type | Description | | :------ | :------ | :------ | -| `options?` | [`YagnaOptions`](../modules/utils_yagna_yagna#yagnaoptions) | Options for the Yagna API. | +| `options?` | [`YagnaOptions`](../modules/utils_yagna_yagnaApi#yagnaoptions) | Options for the Yagna API. | #### Returns @@ -40,13 +40,13 @@ Creates an instance of `InvoiceProcessor` and connects to the Yagna API. #### Defined in -[src/payment/InvoiceProcessor.ts:36](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/InvoiceProcessor.ts#L36) +[src/payment/InvoiceProcessor.ts:35](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/InvoiceProcessor.ts#L35) ___ ### collectInvoices -▸ **collectInvoices**(`«destructured»?`): `Promise`\<`Invoice`[]\> +▸ **collectInvoices**(`«destructured»?`): `Promise`\<{}[]\> Collects invoices from the Yagna API until the limit is reached or there are no more invoices. @@ -66,7 +66,7 @@ Collects invoices from the Yagna API until the limit is reached or there are no #### Returns -`Promise`\<`Invoice`[]\> +`Promise`\<{}[]\> **`Example`** @@ -85,7 +85,7 @@ const invoices = await invoiceProcessor.collectInvoices({ #### Defined in -[src/payment/InvoiceProcessor.ts:68](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/InvoiceProcessor.ts#L68) +[src/payment/InvoiceProcessor.ts:66](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/InvoiceProcessor.ts#L66) ___ @@ -107,7 +107,7 @@ Fetches a single invoice from the Yagna API. #### Defined in -[src/payment/InvoiceProcessor.ts:120](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/InvoiceProcessor.ts#L120) +[src/payment/InvoiceProcessor.ts:118](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/InvoiceProcessor.ts#L118) ___ @@ -132,7 +132,7 @@ If `dryRun` is `true`, no allocation will be created and the invoice will not be #### Defined in -[src/payment/InvoiceProcessor.ts:128](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/InvoiceProcessor.ts#L128) +[src/payment/InvoiceProcessor.ts:126](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/InvoiceProcessor.ts#L126) ___ @@ -162,4 +162,4 @@ Use the returned `InvoiceAcceptResult` to check which invoices were accepted suc #### Defined in -[src/payment/InvoiceProcessor.ts:193](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/InvoiceProcessor.ts#L193) +[src/payment/InvoiceProcessor.ts:191](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/InvoiceProcessor.ts#L191) diff --git a/src/pages/docs/golem-js/reference/classes/payment_agreement_payment_process.AgreementPaymentProcess.md b/src/pages/docs/golem-js/reference/classes/payment_agreement_payment_process.AgreementPaymentProcess.md index 46d2ddb0c..f5b5ba034 100644 --- a/src/pages/docs/golem-js/reference/classes/payment_agreement_payment_process.AgreementPaymentProcess.md +++ b/src/pages/docs/golem-js/reference/classes/payment_agreement_payment_process.AgreementPaymentProcess.md @@ -52,7 +52,7 @@ Process manager that controls the logic behind processing events related to an a #### Defined in -[src/payment/agreement_payment_process.ts:28](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/agreement_payment_process.ts#L28) +[src/payment/agreement_payment_process.ts:28](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/agreement_payment_process.ts#L28) ## Properties @@ -62,7 +62,7 @@ Process manager that controls the logic behind processing events related to an a #### Defined in -[src/payment/agreement_payment_process.ts:26](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/agreement_payment_process.ts#L26) +[src/payment/agreement_payment_process.ts:26](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/agreement_payment_process.ts#L26) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[src/payment/agreement_payment_process.ts:29](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/agreement_payment_process.ts#L29) +[src/payment/agreement_payment_process.ts:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/agreement_payment_process.ts#L29) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[src/payment/agreement_payment_process.ts:30](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/agreement_payment_process.ts#L30) +[src/payment/agreement_payment_process.ts:30](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/agreement_payment_process.ts#L30) ___ @@ -99,7 +99,7 @@ ___ #### Defined in -[src/payment/agreement_payment_process.ts:31](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/agreement_payment_process.ts#L31) +[src/payment/agreement_payment_process.ts:31](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/agreement_payment_process.ts#L31) ## Methods @@ -121,7 +121,7 @@ Adds the debit note to the process avoiding race conditions #### Defined in -[src/payment/agreement_payment_process.ts:43](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/agreement_payment_process.ts#L43) +[src/payment/agreement_payment_process.ts:43](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/agreement_payment_process.ts#L43) ___ @@ -143,7 +143,7 @@ Adds the invoice to the process avoiding race conditions #### Defined in -[src/payment/agreement_payment_process.ts:50](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/agreement_payment_process.ts#L50) +[src/payment/agreement_payment_process.ts:50](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/agreement_payment_process.ts#L50) ___ @@ -159,4 +159,4 @@ Tells if the process reached a point in which we can consider it as "finished" #### Defined in -[src/payment/agreement_payment_process.ts:57](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/agreement_payment_process.ts#L57) +[src/payment/agreement_payment_process.ts:57](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/agreement_payment_process.ts#L57) diff --git a/src/pages/docs/golem-js/reference/classes/payment_error.GolemPaymentError.md b/src/pages/docs/golem-js/reference/classes/payment_error.GolemPaymentError.md index d81f0a0c4..067f6fb10 100644 --- a/src/pages/docs/golem-js/reference/classes/payment_error.GolemPaymentError.md +++ b/src/pages/docs/golem-js/reference/classes/payment_error.GolemPaymentError.md @@ -27,10 +27,13 @@ additionally containing an error code specific to a given subdomain ### Properties - [code](payment_error.GolemPaymentError#code) -- [allocation](payment_error.GolemPaymentError#allocation) -- [provider](payment_error.GolemPaymentError#provider) - [previous](payment_error.GolemPaymentError#previous) +### Methods + +- [getAllocation](payment_error.GolemPaymentError#getallocation) +- [getProvider](payment_error.GolemPaymentError#getprovider) + ## Constructors ### constructor @@ -57,7 +60,7 @@ additionally containing an error code specific to a given subdomain #### Defined in -[src/payment/error.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L19) +[src/payment/error.ts:21](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L21) ## Properties @@ -71,40 +74,48 @@ additionally containing an error code specific to a given subdomain #### Defined in -[src/payment/error.ts:21](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L21) +[src/payment/error.ts:23](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L23) ___ -### allocation +### previous + +• `Optional` **previous**: `Error` -• `Optional` **allocation**: `Allocation` +The previous error, if any, that led to this error. + +#### Inherited from + +[GolemModuleError](error_golem_error.GolemModuleError).[previous](error_golem_error.GolemModuleError#previous) #### Defined in -[src/payment/error.ts:22](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L22) +[src/payment/error.ts:26](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L26) -___ +## Methods -### provider +### getAllocation -• `Optional` **provider**: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) +▸ **getAllocation**(): `undefined` \| `Allocation` + +#### Returns + +`undefined` \| `Allocation` #### Defined in -[src/payment/error.ts:23](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L23) +[src/payment/error.ts:32](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L32) ___ -### previous - -• `Optional` **previous**: `Error` +### getProvider -The previous error, if any, that led to this error. +▸ **getProvider**(): `undefined` \| [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) -#### Inherited from +#### Returns -[GolemModuleError](error_golem_error.GolemModuleError).[previous](error_golem_error.GolemModuleError#previous) +`undefined` \| [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) #### Defined in -[src/payment/error.ts:24](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L24) +[src/payment/error.ts:35](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L35) diff --git a/src/pages/docs/golem-js/reference/classes/payment_payments.Payments.md b/src/pages/docs/golem-js/reference/classes/payment_payments.Payments.md index 844e1ac4b..d1de2f00c 100644 --- a/src/pages/docs/golem-js/reference/classes/payment_payments.Payments.md +++ b/src/pages/docs/golem-js/reference/classes/payment_payments.Payments.md @@ -8,18 +8,16 @@ type: "JS API Reference" [payment/payments](../modules/payment_payments).Payments -## Hierarchy - -- `EventTarget` - - ↳ **`Payments`** - ## Table of contents ### Constructors - [constructor](payment_payments.Payments#constructor) +### Properties + +- [events](payment_payments.Payments#events) + ### Methods - [create](payment_payments.Payments#create) @@ -35,20 +33,26 @@ type: "JS API Reference" | Name | Type | | :------ | :------ | -| `yagnaApi` | [`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi) | +| `yagnaApi` | [`YagnaApi`](utils_yagna_yagnaApi.YagnaApi) | | `options?` | [`PaymentOptions`](../interfaces/payment_payments.PaymentOptions) | #### Returns [`Payments`](payment_payments.Payments) -#### Overrides +#### Defined in + +[src/payment/payments.ts:33](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/payments.ts#L33) + +## Properties + +### events -EventTarget.constructor +• `Readonly` **events**: `EventEmitter`\<[`PaymentEvents`](../interfaces/payment_payments.PaymentEvents), `any`\> #### Defined in -[src/payment/payments.ts:28](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/payments.ts#L28) +[src/payment/payments.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/payments.ts#L27) ## Methods @@ -60,7 +64,7 @@ EventTarget.constructor | Name | Type | | :------ | :------ | -| `yagnaApi` | [`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi) | +| `yagnaApi` | [`YagnaApi`](utils_yagna_yagnaApi.YagnaApi) | | `options?` | [`PaymentOptions`](../interfaces/payment_payments.PaymentOptions) | #### Returns @@ -69,7 +73,7 @@ EventTarget.constructor #### Defined in -[src/payment/payments.ts:24](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/payments.ts#L24) +[src/payment/payments.ts:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/payments.ts#L29) ___ @@ -86,4 +90,4 @@ An error will be thrown when the unsubscribe timeout expires. #### Defined in -[src/payment/payments.ts:42](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/payments.ts#L42) +[src/payment/payments.ts:46](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/payments.ts#L46) diff --git a/src/pages/docs/golem-js/reference/classes/script_command.DownloadData.md b/src/pages/docs/golem-js/reference/classes/script_command.DownloadData.md index cfd5cceaa..b19fc20c1 100644 --- a/src/pages/docs/golem-js/reference/classes/script_command.DownloadData.md +++ b/src/pages/docs/golem-js/reference/classes/script_command.DownloadData.md @@ -56,7 +56,7 @@ Transfer\<Uint8Array\>.constructor #### Defined in -[src/script/command.ts:199](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L199) +[src/script/command.ts:203](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L203) ## Properties @@ -70,7 +70,7 @@ Transfer.from #### Defined in -[src/script/command.ts:116](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L116) +[src/script/command.ts:120](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L120) ___ @@ -84,7 +84,7 @@ Transfer.to #### Defined in -[src/script/command.ts:117](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L117) +[src/script/command.ts:121](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L121) ___ @@ -98,7 +98,7 @@ Transfer.args #### Defined in -[src/script/command.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L16) +[src/script/command.ts:20](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L20) ## Methods @@ -116,7 +116,7 @@ Transfer.before #### Defined in -[src/script/command.ts:207](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L207) +[src/script/command.ts:211](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L211) ___ @@ -140,7 +140,7 @@ Transfer.after #### Defined in -[src/script/command.ts:214](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L214) +[src/script/command.ts:218](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L218) ___ @@ -158,7 +158,7 @@ Transfer.toJson #### Defined in -[src/script/command.ts:25](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L25) +[src/script/command.ts:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L29) ___ @@ -176,4 +176,4 @@ Transfer.toExeScriptRequest #### Defined in -[src/script/command.ts:31](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L31) +[src/script/command.ts:35](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L35) diff --git a/src/pages/docs/golem-js/reference/classes/script_command.Terminate.md b/src/pages/docs/golem-js/reference/classes/script_command.Terminate.md index e4e16e6b9..938b9c230 100644 --- a/src/pages/docs/golem-js/reference/classes/script_command.Terminate.md +++ b/src/pages/docs/golem-js/reference/classes/script_command.Terminate.md @@ -53,7 +53,7 @@ Command.constructor #### Defined in -[src/script/command.ts:106](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L106) +[src/script/command.ts:110](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L110) ## Properties @@ -67,7 +67,7 @@ Command.args #### Defined in -[src/script/command.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L16) +[src/script/command.ts:20](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L20) ## Methods @@ -85,7 +85,7 @@ Command.toJson #### Defined in -[src/script/command.ts:25](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L25) +[src/script/command.ts:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L29) ___ @@ -103,7 +103,7 @@ Command.toExeScriptRequest #### Defined in -[src/script/command.ts:31](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L31) +[src/script/command.ts:35](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L35) ___ @@ -123,7 +123,7 @@ Command.before #### Defined in -[src/script/command.ts:38](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L38) +[src/script/command.ts:42](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L42) ___ @@ -155,4 +155,4 @@ Command.after #### Defined in -[src/script/command.ts:53](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L53) +[src/script/command.ts:57](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L57) diff --git a/src/pages/docs/golem-js/reference/classes/script_command.UploadData.md b/src/pages/docs/golem-js/reference/classes/script_command.UploadData.md index 7d385b008..0cc99a572 100644 --- a/src/pages/docs/golem-js/reference/classes/script_command.UploadData.md +++ b/src/pages/docs/golem-js/reference/classes/script_command.UploadData.md @@ -57,7 +57,7 @@ Transfer.constructor #### Defined in -[src/script/command.ts:151](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L151) +[src/script/command.ts:155](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L155) ## Properties @@ -71,7 +71,7 @@ Transfer.from #### Defined in -[src/script/command.ts:116](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L116) +[src/script/command.ts:120](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L120) ___ @@ -85,7 +85,7 @@ Transfer.to #### Defined in -[src/script/command.ts:117](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L117) +[src/script/command.ts:121](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L121) ___ @@ -99,7 +99,7 @@ Transfer.args #### Defined in -[src/script/command.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L16) +[src/script/command.ts:20](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L20) ## Methods @@ -117,7 +117,7 @@ Transfer.before #### Defined in -[src/script/command.ts:160](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L160) +[src/script/command.ts:164](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L164) ___ @@ -141,7 +141,7 @@ Transfer.after #### Defined in -[src/script/command.ts:164](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L164) +[src/script/command.ts:168](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L168) ___ @@ -159,7 +159,7 @@ Transfer.toJson #### Defined in -[src/script/command.ts:25](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L25) +[src/script/command.ts:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L29) ___ @@ -177,4 +177,4 @@ Transfer.toExeScriptRequest #### Defined in -[src/script/command.ts:31](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L31) +[src/script/command.ts:35](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L35) diff --git a/src/pages/docs/golem-js/reference/classes/storage_gftp.GftpStorageProvider.md b/src/pages/docs/golem-js/reference/classes/storage_gftp.GftpStorageProvider.md index a759ea814..4bceaaf5c 100644 --- a/src/pages/docs/golem-js/reference/classes/storage_gftp.GftpStorageProvider.md +++ b/src/pages/docs/golem-js/reference/classes/storage_gftp.GftpStorageProvider.md @@ -47,7 +47,7 @@ type: "JS API Reference" #### Defined in -[src/storage/gftp.ts:26](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/gftp.ts#L26) +[src/storage/gftp.ts:26](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/gftp.ts#L26) ## Methods @@ -67,7 +67,7 @@ Initialize storage provider. #### Defined in -[src/storage/gftp.ts:33](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/gftp.ts#L33) +[src/storage/gftp.ts:33](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/gftp.ts#L33) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[src/storage/gftp.ts:66](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/gftp.ts#L66) +[src/storage/gftp.ts:66](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/gftp.ts#L66) ___ @@ -107,7 +107,7 @@ Return allocated resource URL from Yagna of a file to be downloaded. #### Defined in -[src/storage/gftp.ts:78](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/gftp.ts#L78) +[src/storage/gftp.ts:78](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/gftp.ts#L78) ___ @@ -127,7 +127,7 @@ Return allocated resource URL from Yagna of a file to be downloaded. #### Defined in -[src/storage/gftp.ts:83](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/gftp.ts#L83) +[src/storage/gftp.ts:83](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/gftp.ts#L83) ___ @@ -153,7 +153,7 @@ Return allocated resource URL from Yagna of a file to be uploaded. #### Defined in -[src/storage/gftp.ts:87](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/gftp.ts#L87) +[src/storage/gftp.ts:87](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/gftp.ts#L87) ___ @@ -179,7 +179,7 @@ Return allocated resource URL from Yagna of data to be uploaded. #### Defined in -[src/storage/gftp.ts:93](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/gftp.ts#L93) +[src/storage/gftp.ts:93](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/gftp.ts#L93) ___ @@ -199,7 +199,7 @@ Release previously allocated resource URL from Yagna. #### Defined in -[src/storage/gftp.ts:105](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/gftp.ts#L105) +[src/storage/gftp.ts:105](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/gftp.ts#L105) ___ @@ -219,4 +219,4 @@ Close storage provider and release all resources. #### Defined in -[src/storage/gftp.ts:119](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/gftp.ts#L119) +[src/storage/gftp.ts:119](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/gftp.ts#L119) diff --git a/src/pages/docs/golem-js/reference/classes/storage_null.NullStorageProvider.md b/src/pages/docs/golem-js/reference/classes/storage_null.NullStorageProvider.md index 63d734811..0d77e9e0c 100644 --- a/src/pages/docs/golem-js/reference/classes/storage_null.NullStorageProvider.md +++ b/src/pages/docs/golem-js/reference/classes/storage_null.NullStorageProvider.md @@ -63,7 +63,7 @@ Close storage provider and release all resources. #### Defined in -[src/storage/null.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/null.ts#L15) +[src/storage/null.ts:15](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/null.ts#L15) ___ @@ -83,7 +83,7 @@ Initialize storage provider. #### Defined in -[src/storage/null.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/null.ts#L19) +[src/storage/null.ts:19](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/null.ts#L19) ___ @@ -109,7 +109,7 @@ Return allocated resource URL from Yagna of data to be uploaded. #### Defined in -[src/storage/null.ts:24](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/null.ts#L24) +[src/storage/null.ts:24](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/null.ts#L24) ___ @@ -135,7 +135,7 @@ Return allocated resource URL from Yagna of a file to be uploaded. #### Defined in -[src/storage/null.ts:29](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/null.ts#L29) +[src/storage/null.ts:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/null.ts#L29) ___ @@ -161,7 +161,7 @@ Return allocated resource URL from Yagna of a file to be downloaded. #### Defined in -[src/storage/null.ts:34](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/null.ts#L34) +[src/storage/null.ts:34](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/null.ts#L34) ___ @@ -187,7 +187,7 @@ Return allocated resource URL from Yagna of a file to be downloaded. #### Defined in -[src/storage/null.ts:39](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/null.ts#L39) +[src/storage/null.ts:39](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/null.ts#L39) ___ @@ -213,4 +213,4 @@ Release previously allocated resource URL from Yagna. #### Defined in -[src/storage/null.ts:44](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/null.ts#L44) +[src/storage/null.ts:44](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/null.ts#L44) diff --git a/src/pages/docs/golem-js/reference/classes/storage_ws_browser.WebSocketBrowserStorageProvider.md b/src/pages/docs/golem-js/reference/classes/storage_ws_browser.WebSocketBrowserStorageProvider.md index 66865a87a..4b3aa744a 100644 --- a/src/pages/docs/golem-js/reference/classes/storage_ws_browser.WebSocketBrowserStorageProvider.md +++ b/src/pages/docs/golem-js/reference/classes/storage_ws_browser.WebSocketBrowserStorageProvider.md @@ -40,7 +40,7 @@ Storage provider that uses GFTP over WebSockets. | Name | Type | | :------ | :------ | -| `yagnaApi` | [`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi) | +| `yagnaApi` | [`YagnaApi`](utils_yagna_yagnaApi.YagnaApi) | | `options` | [`WebSocketStorageProviderOptions`](../interfaces/storage_ws_browser.WebSocketStorageProviderOptions) | #### Returns @@ -49,7 +49,7 @@ Storage provider that uses GFTP over WebSockets. #### Defined in -[src/storage/ws-browser.ts:62](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/ws-browser.ts#L62) +[src/storage/ws-browser.ts:63](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/ws-browser.ts#L63) ## Methods @@ -69,7 +69,7 @@ Close storage provider and release all resources. #### Defined in -[src/storage/ws-browser.ts:69](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/ws-browser.ts#L69) +[src/storage/ws-browser.ts:70](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/ws-browser.ts#L70) ___ @@ -89,7 +89,7 @@ Initialize storage provider. #### Defined in -[src/storage/ws-browser.ts:73](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/ws-browser.ts#L73) +[src/storage/ws-browser.ts:74](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/ws-browser.ts#L74) ___ @@ -115,7 +115,7 @@ Return allocated resource URL from Yagna of data to be uploaded. #### Defined in -[src/storage/ws-browser.ts:77](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/ws-browser.ts#L77) +[src/storage/ws-browser.ts:78](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/ws-browser.ts#L78) ___ @@ -135,7 +135,7 @@ Return allocated resource URL from Yagna of a file to be uploaded. #### Defined in -[src/storage/ws-browser.ts:102](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/ws-browser.ts#L102) +[src/storage/ws-browser.ts:103](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/ws-browser.ts#L103) ___ @@ -161,7 +161,7 @@ Return allocated resource URL from Yagna of a file to be downloaded. #### Defined in -[src/storage/ws-browser.ts:106](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/ws-browser.ts#L106) +[src/storage/ws-browser.ts:107](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/ws-browser.ts#L107) ___ @@ -181,7 +181,7 @@ Return allocated resource URL from Yagna of a file to be downloaded. #### Defined in -[src/storage/ws-browser.ts:132](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/ws-browser.ts#L132) +[src/storage/ws-browser.ts:133](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/ws-browser.ts#L133) ___ @@ -207,4 +207,4 @@ Release previously allocated resource URL from Yagna. #### Defined in -[src/storage/ws-browser.ts:136](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/ws-browser.ts#L136) +[src/storage/ws-browser.ts:137](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/ws-browser.ts#L137) diff --git a/src/pages/docs/golem-js/reference/classes/task_error.GolemWorkError.md b/src/pages/docs/golem-js/reference/classes/task_error.GolemWorkError.md deleted file mode 100644 index ffa8f3180..000000000 --- a/src/pages/docs/golem-js/reference/classes/task_error.GolemWorkError.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: "Class GolemWorkError" -pageTitle: "Class GolemWorkError - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class GolemWorkError within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: GolemWorkError - -[task/error](../modules/task_error).GolemWorkError - -Module specific errors - Market, Work, Payment. -Each of the major modules will have its own domain specific root error type, -additionally containing an error code specific to a given subdomain - -## Hierarchy - -- [`GolemModuleError`](error_golem_error.GolemModuleError) - - ↳ **`GolemWorkError`** - -## Table of contents - -### Constructors - -- [constructor](task_error.GolemWorkError#constructor) - -### Properties - -- [code](task_error.GolemWorkError#code) -- [agreement](task_error.GolemWorkError#agreement) -- [activity](task_error.GolemWorkError#activity) -- [provider](task_error.GolemWorkError#provider) -- [previous](task_error.GolemWorkError#previous) - -## Constructors - -### constructor - -• **new GolemWorkError**(`message`, `code`, `agreement?`, `activity?`, `provider?`, `previous?`): [`GolemWorkError`](task_error.GolemWorkError) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `code` | [`WorkErrorCode`](../enums/task_error.WorkErrorCode) | -| `agreement?` | `Agreement` | -| `activity?` | [`Activity`](activity_activity.Activity) | -| `provider?` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | -| `previous?` | `Error` | - -#### Returns - -[`GolemWorkError`](task_error.GolemWorkError) - -#### Overrides - -[GolemModuleError](error_golem_error.GolemModuleError).[constructor](error_golem_error.GolemModuleError#constructor) - -#### Defined in - -[src/task/error.ts:20](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L20) - -## Properties - -### code - -• **code**: [`WorkErrorCode`](../enums/task_error.WorkErrorCode) - -#### Inherited from - -[GolemModuleError](error_golem_error.GolemModuleError).[code](error_golem_error.GolemModuleError#code) - -#### Defined in - -[src/task/error.ts:22](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L22) - -___ - -### agreement - -• `Optional` **agreement**: `Agreement` - -#### Defined in - -[src/task/error.ts:23](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L23) - -___ - -### activity - -• `Optional` **activity**: [`Activity`](activity_activity.Activity) - -#### Defined in - -[src/task/error.ts:24](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L24) - -___ - -### provider - -• `Optional` **provider**: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) - -#### Defined in - -[src/task/error.ts:25](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L25) - -___ - -### previous - -• `Optional` **previous**: `Error` - -The previous error, if any, that led to this error. - -#### Inherited from - -[GolemModuleError](error_golem_error.GolemModuleError).[previous](error_golem_error.GolemModuleError#previous) - -#### Defined in - -[src/task/error.ts:26](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L26) diff --git a/src/pages/docs/golem-js/reference/classes/task_task.Task.md b/src/pages/docs/golem-js/reference/classes/task_task.Task.md deleted file mode 100644 index 0f3ca0f74..000000000 --- a/src/pages/docs/golem-js/reference/classes/task_task.Task.md +++ /dev/null @@ -1,416 +0,0 @@ ---- -title: "Class Task" -pageTitle: "Class Task - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class Task within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: Task\ - -[task/task](../modules/task_task).Task - -One computation unit. - -**`Description`** - -Represents one computation unit that will be run on the one provider machine (e.g. rendering of one frame of an animation). - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `OutputType` | `unknown` | - -## Implements - -- `QueueableTask` - -## Table of contents - -### Constructors - -- [constructor](task_task.Task#constructor) - -### Properties - -- [id](task_task.Task#id) - -### Methods - -- [onStateChange](task_task.Task#onstatechange) -- [cleanup](task_task.Task#cleanup) -- [init](task_task.Task#init) -- [start](task_task.Task#start) -- [stop](task_task.Task#stop) -- [isQueueable](task_task.Task#isqueueable) -- [isRetry](task_task.Task#isretry) -- [isDone](task_task.Task#isdone) -- [isFinished](task_task.Task#isfinished) -- [isRejected](task_task.Task#isrejected) -- [isQueued](task_task.Task#isqueued) -- [isPending](task_task.Task#ispending) -- [isNew](task_task.Task#isnew) -- [isFailed](task_task.Task#isfailed) -- [getResults](task_task.Task#getresults) -- [getWorker](task_task.Task#getworker) -- [getActivityReadySetupFunctions](task_task.Task#getactivityreadysetupfunctions) -- [getRetriesCount](task_task.Task#getretriescount) -- [getError](task_task.Task#geterror) -- [getActivity](task_task.Task#getactivity) -- [getNetworkNode](task_task.Task#getnetworknode) - -## Constructors - -### constructor - -• **new Task**\<`OutputType`\>(`id`, `worker`, `options?`): [`Task`](task_task.Task)\<`OutputType`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `OutputType` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `worker` | [`Worker`](../modules/task_work#worker)\<`OutputType`\> | -| `options?` | [`TaskOptions`](../modules/task_task#taskoptions) | - -#### Returns - -[`Task`](task_task.Task)\<`OutputType`\> - -#### Defined in - -[src/task/task.ts:48](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L48) - -## Properties - -### id - -• `Readonly` **id**: `string` - -#### Defined in - -[src/task/task.ts:49](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L49) - -## Methods - -### onStateChange - -▸ **onStateChange**(`listener`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `listener` | (`state`: [`TaskState`](../enums/task_task.TaskState)) => `void` | - -#### Returns - -`void` - -#### Defined in - -[src/task/task.ts:61](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L61) - -___ - -### cleanup - -▸ **cleanup**(): `void` - -#### Returns - -`void` - -#### Defined in - -[src/task/task.ts:64](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L64) - -___ - -### init - -▸ **init**(): `void` - -#### Returns - -`void` - -#### Defined in - -[src/task/task.ts:68](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L68) - -___ - -### start - -▸ **start**(`activity`, `networkNode?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `activity` | [`Activity`](activity_activity.Activity) | -| `networkNode?` | [`NetworkNode`](network_node.NetworkNode) | - -#### Returns - -`void` - -#### Defined in - -[src/task/task.ts:72](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L72) - -___ - -### stop - -▸ **stop**(`results?`, `error?`, `retry?`): `void` - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `results?` | `OutputType` | `undefined` | -| `error?` | `Error` | `undefined` | -| `retry` | `boolean` | `true` | - -#### Returns - -`void` - -#### Defined in - -[src/task/task.ts:82](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L82) - -___ - -### isQueueable - -▸ **isQueueable**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -QueueableTask.isQueueable - -#### Defined in - -[src/task/task.ts:101](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L101) - -___ - -### isRetry - -▸ **isRetry**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/task/task.ts:104](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L104) - -___ - -### isDone - -▸ **isDone**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/task/task.ts:107](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L107) - -___ - -### isFinished - -▸ **isFinished**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/task/task.ts:110](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L110) - -___ - -### isRejected - -▸ **isRejected**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/task/task.ts:113](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L113) - -___ - -### isQueued - -▸ **isQueued**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/task/task.ts:116](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L116) - -___ - -### isPending - -▸ **isPending**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/task/task.ts:119](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L119) - -___ - -### isNew - -▸ **isNew**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/task/task.ts:122](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L122) - -___ - -### isFailed - -▸ **isFailed**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -[src/task/task.ts:125](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L125) - -___ - -### getResults - -▸ **getResults**(): `undefined` \| `OutputType` - -#### Returns - -`undefined` \| `OutputType` - -#### Defined in - -[src/task/task.ts:128](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L128) - -___ - -### getWorker - -▸ **getWorker**(): [`Worker`](../modules/task_work#worker)\<`OutputType`\> - -#### Returns - -[`Worker`](../modules/task_work#worker)\<`OutputType`\> - -#### Defined in - -[src/task/task.ts:131](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L131) - -___ - -### getActivityReadySetupFunctions - -▸ **getActivityReadySetupFunctions**(): [`Worker`](../modules/task_work#worker)\<`unknown`\>[] - -#### Returns - -[`Worker`](../modules/task_work#worker)\<`unknown`\>[] - -#### Defined in - -[src/task/task.ts:134](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L134) - -___ - -### getRetriesCount - -▸ **getRetriesCount**(): `number` - -#### Returns - -`number` - -#### Defined in - -[src/task/task.ts:137](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L137) - -___ - -### getError - -▸ **getError**(): `undefined` \| `Error` - -#### Returns - -`undefined` \| `Error` - -#### Defined in - -[src/task/task.ts:140](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L140) - -___ - -### getActivity - -▸ **getActivity**(): `undefined` \| [`Activity`](activity_activity.Activity) - -#### Returns - -`undefined` \| [`Activity`](activity_activity.Activity) - -#### Defined in - -[src/task/task.ts:143](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L143) - -___ - -### getNetworkNode - -▸ **getNetworkNode**(): `undefined` \| [`NetworkNode`](network_node.NetworkNode) - -#### Returns - -`undefined` \| [`NetworkNode`](network_node.NetworkNode) - -#### Defined in - -[src/task/task.ts:146](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L146) diff --git a/src/pages/docs/golem-js/reference/classes/task_work.WorkContext.md b/src/pages/docs/golem-js/reference/classes/task_work.WorkContext.md deleted file mode 100644 index bef4b3ae9..000000000 --- a/src/pages/docs/golem-js/reference/classes/task_work.WorkContext.md +++ /dev/null @@ -1,397 +0,0 @@ ---- -title: "Class WorkContext" -pageTitle: "Class WorkContext - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class WorkContext within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: WorkContext - -[task/work](../modules/task_work).WorkContext - -Work Context - -**`Description`** - -## Table of contents - -### Constructors - -- [constructor](task_work.WorkContext#constructor) - -### Properties - -- [provider](task_work.WorkContext#provider) -- [activity](task_work.WorkContext#activity) - -### Methods - -- [before](task_work.WorkContext#before) -- [run](task_work.WorkContext#run) -- [spawn](task_work.WorkContext#spawn) -- [transfer](task_work.WorkContext#transfer) -- [uploadFile](task_work.WorkContext#uploadfile) -- [uploadJson](task_work.WorkContext#uploadjson) -- [uploadData](task_work.WorkContext#uploaddata) -- [downloadFile](task_work.WorkContext#downloadfile) -- [downloadData](task_work.WorkContext#downloaddata) -- [downloadJson](task_work.WorkContext#downloadjson) -- [beginBatch](task_work.WorkContext#beginbatch) -- [getWebsocketUri](task_work.WorkContext#getwebsocketuri) -- [getIp](task_work.WorkContext#getip) -- [getState](task_work.WorkContext#getstate) - -## Constructors - -### constructor - -• **new WorkContext**(`activity`, `options?`): [`WorkContext`](task_work.WorkContext) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `activity` | [`Activity`](activity_activity.Activity) | -| `options?` | [`WorkOptions`](../interfaces/task_work.WorkOptions) | - -#### Returns - -[`WorkContext`](task_work.WorkContext) - -#### Defined in - -[src/task/work.ts:59](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L59) - -## Properties - -### provider - -• `Readonly` **provider**: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) - -#### Defined in - -[src/task/work.ts:52](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L52) - -___ - -### activity - -• `Readonly` **activity**: [`Activity`](activity_activity.Activity) - -#### Defined in - -[src/task/work.ts:60](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L60) - -## Methods - -### before - -▸ **before**(): `Promise`\<`void` \| [`Result`](activity_results.Result)\<`any`\>[]\> - -#### Returns - -`Promise`\<`void` \| [`Result`](activity_results.Result)\<`any`\>[]\> - -#### Defined in - -[src/task/work.ts:70](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L70) - -___ - -### run - -▸ **run**(`commandLine`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -Execute a command on provider using a shell (/bin/sh). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `commandLine` | `string` | Shell command to execute. | -| `options?` | [`CommandOptions`](../interfaces/task_work.CommandOptions) | Additional run options. | - -#### Returns - -`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -#### Defined in - -[src/task/work.ts:167](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L167) - -▸ **run**(`executable`, `args`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -Execute an executable on provider. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `executable` | `string` | Executable to run. | -| `args` | `string`[] | Executable arguments. | -| `options?` | [`CommandOptions`](../interfaces/task_work.CommandOptions) | Additional run options. | - -#### Returns - -`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -#### Defined in - -[src/task/work.ts:176](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L176) - -___ - -### spawn - -▸ **spawn**(`commandLine`, `options?`): `Promise`\<[`RemoteProcess`](task_process.RemoteProcess)\> - -Spawn an executable on provider and return [RemoteProcess](task_process.RemoteProcess) object -that contain stdout and stderr as Readable - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `commandLine` | `string` | Shell command to execute. | -| `options?` | `Omit`\<[`CommandOptions`](../interfaces/task_work.CommandOptions), ``"capture"``\> | Additional run options. | - -#### Returns - -`Promise`\<[`RemoteProcess`](task_process.RemoteProcess)\> - -#### Defined in - -[src/task/work.ts:200](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L200) - -▸ **spawn**(`executable`, `args`, `options?`): `Promise`\<[`RemoteProcess`](task_process.RemoteProcess)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `executable` | `string` | Executable to run. | -| `args` | `string`[] | Executable arguments. | -| `options?` | [`CommandOptions`](../interfaces/task_work.CommandOptions) | Additional run options. | - -#### Returns - -`Promise`\<[`RemoteProcess`](task_process.RemoteProcess)\> - -#### Defined in - -[src/task/work.ts:206](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L206) - -___ - -### transfer - -▸ **transfer**(`from`, `to`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -Generic transfer command, requires the user to provide a publicly readable transfer source - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `from` | `string` | publicly available resource for reading. Supported protocols: file, http, ftp or gftp | -| `to` | `string` | file path | -| `options?` | [`CommandOptions`](../interfaces/task_work.CommandOptions) | Additional run options. | - -#### Returns - -`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -#### Defined in - -[src/task/work.ts:247](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L247) - -___ - -### uploadFile - -▸ **uploadFile**(`src`, `dst`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `src` | `string` | -| `dst` | `string` | -| `options?` | [`CommandOptions`](../interfaces/task_work.CommandOptions) | - -#### Returns - -`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -#### Defined in - -[src/task/work.ts:252](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L252) - -___ - -### uploadJson - -▸ **uploadJson**(`json`, `dst`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `json` | `any` | -| `dst` | `string` | -| `options?` | [`CommandOptions`](../interfaces/task_work.CommandOptions) | - -#### Returns - -`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -#### Defined in - -[src/task/work.ts:258](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L258) - -___ - -### uploadData - -▸ **uploadData**(`data`, `dst`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `Uint8Array` | -| `dst` | `string` | -| `options?` | [`CommandOptions`](../interfaces/task_work.CommandOptions) | - -#### Returns - -`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -#### Defined in - -[src/task/work.ts:264](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L264) - -___ - -### downloadFile - -▸ **downloadFile**(`src`, `dst`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `src` | `string` | -| `dst` | `string` | -| `options?` | [`CommandOptions`](../interfaces/task_work.CommandOptions) | - -#### Returns - -`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -#### Defined in - -[src/task/work.ts:269](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L269) - -___ - -### downloadData - -▸ **downloadData**(`src`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`Uint8Array`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `src` | `string` | -| `options?` | [`CommandOptions`](../interfaces/task_work.CommandOptions) | - -#### Returns - -`Promise`\<[`Result`](activity_results.Result)\<`Uint8Array`\>\> - -#### Defined in - -[src/task/work.ts:274](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L274) - -___ - -### downloadJson - -▸ **downloadJson**(`src`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `src` | `string` | -| `options?` | [`CommandOptions`](../interfaces/task_work.CommandOptions) | - -#### Returns - -`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> - -#### Defined in - -[src/task/work.ts:280](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L280) - -___ - -### beginBatch - -▸ **beginBatch**(): [`Batch`](task_batch.Batch) - -#### Returns - -[`Batch`](task_batch.Batch) - -#### Defined in - -[src/task/work.ts:296](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L296) - -___ - -### getWebsocketUri - -▸ **getWebsocketUri**(`port`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `port` | `number` | - -#### Returns - -`string` - -#### Defined in - -[src/task/work.ts:300](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L300) - -___ - -### getIp - -▸ **getIp**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/task/work.ts:312](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L312) - -___ - -### getState - -▸ **getState**(): `Promise`\<[`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)\> - -#### Returns - -`Promise`\<[`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)\> - -#### Defined in - -[src/task/work.ts:324](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L324) diff --git a/src/pages/docs/golem-js/reference/classes/utils_yagna_activity.RequestorApi.md b/src/pages/docs/golem-js/reference/classes/utils_yagna_activity.RequestorApi.md deleted file mode 100644 index 37b671136..000000000 --- a/src/pages/docs/golem-js/reference/classes/utils_yagna_activity.RequestorApi.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "Class RequestorApi" -pageTitle: "Class RequestorApi - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class RequestorApi within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: RequestorApi - -[utils/yagna/activity](../modules/utils_yagna_activity).RequestorApi - -## Hierarchy - -- `RequestorStateApi` - - ↳ **`RequestorApi`** - -## Table of contents - -### Constructors - -- [constructor](utils_yagna_activity.RequestorApi#constructor) - -### Methods - -- [getActivityAgreementId](utils_yagna_activity.RequestorApi#getactivityagreementid) - -## Constructors - -### constructor - -• **new RequestorApi**(`configuration?`, `basePath?`, `axios?`): [`RequestorApi`](utils_yagna_activity.RequestorApi) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | `Configuration` | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -[`RequestorApi`](utils_yagna_activity.RequestorApi) - -#### Inherited from - -RequestorStateApi.constructor - -#### Defined in - -node_modules/ya-ts-client/dist/ya-activity/base.d.ts:43 - -## Methods - -### getActivityAgreementId - -▸ **getActivityAgreementId**(`activityId`): `Promise`\<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `activityId` | `string` | - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[src/utils/yagna/activity.ts:6](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/activity.ts#L6) diff --git a/src/pages/docs/golem-js/reference/classes/utils_yagna_gsb.RequestorApi.md b/src/pages/docs/golem-js/reference/classes/utils_yagna_gsb.RequestorApi.md deleted file mode 100644 index ed1587aba..000000000 --- a/src/pages/docs/golem-js/reference/classes/utils_yagna_gsb.RequestorApi.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: "Class RequestorApi" -pageTitle: "Class RequestorApi - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class RequestorApi within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: RequestorApi - -[utils/yagna/gsb](../modules/utils_yagna_gsb).RequestorApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`RequestorApi`** - -## Implements - -- `GsbRequestorApi` - -## Table of contents - -### Constructors - -- [constructor](utils_yagna_gsb.RequestorApi#constructor) - -### Methods - -- [createService](utils_yagna_gsb.RequestorApi#createservice) -- [deleteService](utils_yagna_gsb.RequestorApi#deleteservice) - -## Constructors - -### constructor - -• **new RequestorApi**(`configuration?`, `basePath?`, `axios?`): [`RequestorApi`](utils_yagna_gsb.RequestorApi) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | `Configuration` | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -[`RequestorApi`](utils_yagna_gsb.RequestorApi) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -node_modules/ya-ts-client/dist/ya-net/base.d.ts:43 - -## Methods - -### createService - -▸ **createService**(`fileInfo`, `components`): `Promise`\<[`ServiceModel`](../modules/utils_yagna_gsb#servicemodel)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `fileInfo` | [`GftpFileInfo`](../modules/utils_yagna_gsb#gftpfileinfo) | -| `components` | `string`[] | - -#### Returns - -`Promise`\<[`ServiceModel`](../modules/utils_yagna_gsb#servicemodel)\> - -#### Implementation of - -GsbRequestorApi.createService - -#### Defined in - -[src/utils/yagna/gsb.ts:21](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/gsb.ts#L21) - -___ - -### deleteService - -▸ **deleteService**(`id`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -GsbRequestorApi.deleteService - -#### Defined in - -[src/utils/yagna/gsb.ts:45](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/gsb.ts#L45) diff --git a/src/pages/docs/golem-js/reference/classes/utils_yagna_identity.RequestorApi.md b/src/pages/docs/golem-js/reference/classes/utils_yagna_identity.RequestorApi.md deleted file mode 100644 index 334eda0b4..000000000 --- a/src/pages/docs/golem-js/reference/classes/utils_yagna_identity.RequestorApi.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: "Class RequestorApi" -pageTitle: "Class RequestorApi - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class RequestorApi within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: RequestorApi - -[utils/yagna/identity](../modules/utils_yagna_identity).RequestorApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`RequestorApi`** - -## Implements - -- `IdentityRequestorApi` - -## Table of contents - -### Constructors - -- [constructor](utils_yagna_identity.RequestorApi#constructor) - -### Methods - -- [getIdentity](utils_yagna_identity.RequestorApi#getidentity) - -## Constructors - -### constructor - -• **new RequestorApi**(`configuration?`, `basePath?`, `axios?`): [`RequestorApi`](utils_yagna_identity.RequestorApi) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | `Configuration` | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -[`RequestorApi`](utils_yagna_identity.RequestorApi) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -node_modules/ya-ts-client/dist/ya-net/base.d.ts:43 - -## Methods - -### getIdentity - -▸ **getIdentity**(): `Promise`\<[`IdentityModel`](../interfaces/utils_yagna_identity.IdentityModel)\> - -#### Returns - -`Promise`\<[`IdentityModel`](../interfaces/utils_yagna_identity.IdentityModel)\> - -#### Implementation of - -IdentityRequestorApi.getIdentity - -#### Defined in - -[src/utils/yagna/identity.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/identity.ts#L17) diff --git a/src/pages/docs/golem-js/reference/classes/utils_yagna_yagna.Yagna.md b/src/pages/docs/golem-js/reference/classes/utils_yagna_yagna.Yagna.md deleted file mode 100644 index 051d6c978..000000000 --- a/src/pages/docs/golem-js/reference/classes/utils_yagna_yagna.Yagna.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -title: "Class Yagna" -pageTitle: "Class Yagna - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Class Yagna within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Class: Yagna - -[utils/yagna/yagna](../modules/utils_yagna_yagna).Yagna - -## Table of contents - -### Constructors - -- [constructor](utils_yagna_yagna.Yagna#constructor) - -### Properties - -- [apiKey](utils_yagna_yagna.Yagna#apikey) -- [apiBaseUrl](utils_yagna_yagna.Yagna#apibaseurl) - -### Methods - -- [getApi](utils_yagna_yagna.Yagna#getapi) -- [connect](utils_yagna_yagna.Yagna#connect) -- [end](utils_yagna_yagna.Yagna#end) -- [getVersion](utils_yagna_yagna.Yagna#getversion) -- [createApi](utils_yagna_yagna.Yagna#createapi) -- [getApiConfig](utils_yagna_yagna.Yagna#getapiconfig) -- [getApiUrl](utils_yagna_yagna.Yagna#getapiurl) -- [errorHandler](utils_yagna_yagna.Yagna#errorhandler) -- [addErrorHandler](utils_yagna_yagna.Yagna#adderrorhandler) - -## Constructors - -### constructor - -• **new Yagna**(`options?`): [`Yagna`](utils_yagna_yagna.Yagna) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | [`YagnaOptions`](../modules/utils_yagna_yagna#yagnaoptions) | - -#### Returns - -[`Yagna`](utils_yagna_yagna.Yagna) - -#### Defined in - -[src/utils/yagna/yagna.ts:61](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L61) - -## Properties - -### apiKey - -• `Protected` `Readonly` **apiKey**: `string` - -#### Defined in - -[src/utils/yagna/yagna.ts:57](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L57) - -___ - -### apiBaseUrl - -• `Protected` `Readonly` **apiBaseUrl**: `string` - -#### Defined in - -[src/utils/yagna/yagna.ts:58](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L58) - -## Methods - -### getApi - -▸ **getApi**(): [`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi) - -#### Returns - -[`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi) - -#### Defined in - -[src/utils/yagna/yagna.ts:70](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L70) - -___ - -### connect - -▸ **connect**(): `Promise`\<[`IdentityModel`](../interfaces/utils_yagna_identity.IdentityModel)\> - -#### Returns - -`Promise`\<[`IdentityModel`](../interfaces/utils_yagna_identity.IdentityModel)\> - -#### Defined in - -[src/utils/yagna/yagna.ts:74](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L74) - -___ - -### end - -▸ **end**(): `Promise`\<`void`\> - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/utils/yagna/yagna.ts:99](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L99) - -___ - -### getVersion - -▸ **getVersion**(): `Promise`\<`string`\> - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[src/utils/yagna/yagna.ts:104](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L104) - -___ - -### createApi - -▸ **createApi**(): [`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi) - -#### Returns - -[`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi) - -#### Defined in - -[src/utils/yagna/yagna.ts:117](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L117) - -___ - -### getApiConfig - -▸ **getApiConfig**(): `Configuration` - -#### Returns - -`Configuration` - -#### Defined in - -[src/utils/yagna/yagna.ts:142](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L142) - -___ - -### getApiUrl - -▸ **getApiUrl**(`apiName?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `apiName?` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/yagna/yagna.ts:153](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L153) - -___ - -### errorHandler - -▸ **errorHandler**(`error`): `Promise`\<`Error`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `error` | `Error` | - -#### Returns - -`Promise`\<`Error`\> - -#### Defined in - -[src/utils/yagna/yagna.ts:157](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L157) - -___ - -### addErrorHandler - -▸ **addErrorHandler**(`api`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `api` | [`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi) | - -#### Returns - -`void` - -#### Defined in - -[src/utils/yagna/yagna.ts:169](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L169) diff --git a/src/pages/docs/golem-js/reference/classes/utils_yagna_yagnaApi.YagnaApi.md b/src/pages/docs/golem-js/reference/classes/utils_yagna_yagnaApi.YagnaApi.md new file mode 100644 index 000000000..0ea975d0e --- /dev/null +++ b/src/pages/docs/golem-js/reference/classes/utils_yagna_yagnaApi.YagnaApi.md @@ -0,0 +1,198 @@ +--- +title: "Class YagnaApi" +pageTitle: "Class YagnaApi - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Class YagnaApi within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Class: YagnaApi + +[utils/yagna/yagnaApi](../modules/utils_yagna_yagnaApi).YagnaApi + +Utility class that groups various Yagna APIs under a single wrapper + +## Table of contents + +### Constructors + +- [constructor](utils_yagna_yagnaApi.YagnaApi#constructor) + +### Properties + +- [appSessionId](utils_yagna_yagnaApi.YagnaApi#appsessionid) +- [yagnaOptions](utils_yagna_yagnaApi.YagnaApi#yagnaoptions) +- [basePath](utils_yagna_yagnaApi.YagnaApi#basepath) +- [identity](utils_yagna_yagnaApi.YagnaApi#identity) +- [market](utils_yagna_yagnaApi.YagnaApi#market) +- [activity](utils_yagna_yagnaApi.YagnaApi#activity) +- [net](utils_yagna_yagnaApi.YagnaApi#net) +- [payment](utils_yagna_yagnaApi.YagnaApi#payment) +- [gsb](utils_yagna_yagnaApi.YagnaApi#gsb) +- [version](utils_yagna_yagnaApi.YagnaApi#version) + +### Methods + +- [connect](utils_yagna_yagnaApi.YagnaApi#connect) +- [getVersion](utils_yagna_yagnaApi.YagnaApi#getversion) + +## Constructors + +### constructor + +• **new YagnaApi**(`options?`): [`YagnaApi`](utils_yagna_yagnaApi.YagnaApi) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | [`YagnaOptions`](../modules/utils_yagna_yagnaApi#yagnaoptions) | + +#### Returns + +[`YagnaApi`](utils_yagna_yagnaApi.YagnaApi) + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:54](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L54) + +## Properties + +### appSessionId + +• `Readonly` **appSessionId**: `string` + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:24](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L24) + +___ + +### yagnaOptions + +• `Readonly` **yagnaOptions**: [`YagnaOptions`](../modules/utils_yagna_yagnaApi#yagnaoptions) + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:26](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L26) + +___ + +### basePath + +• `Readonly` **basePath**: `string` + +Base path used to build paths to Yagna's API + +**`Example`** + +```ts +http://localhost:7465 +``` + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:35](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L35) + +___ + +### identity + +• `Readonly` **identity**: `DefaultService` + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:37](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L37) + +___ + +### market + +• **market**: `RequestorService` + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:39](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L39) + +___ + +### activity + +• **activity**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `control` | `RequestorControlService` | +| `state` | `RequestorStateService` | + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:41](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L41) + +___ + +### net + +• **net**: `RequestorService` + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:46](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L46) + +___ + +### payment + +• **payment**: `RequestorService` + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:48](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L48) + +___ + +### gsb + +• **gsb**: `RequestorService` + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:50](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L50) + +___ + +### version + +• **version**: `DefaultService` + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:52](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L52) + +## Methods + +### connect + +▸ **connect**(): `Promise`\<{}\> + +#### Returns + +`Promise`\<{}\> + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:127](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L127) + +___ + +### getVersion + +▸ **getVersion**(): `Promise`\<`string`\> + +#### Returns + +`Promise`\<`string`\> + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:154](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L154) diff --git a/src/pages/docs/golem-js/reference/classes/task_batch.Batch.md b/src/pages/docs/golem-js/reference/classes/work_batch.Batch.md similarity index 53% rename from src/pages/docs/golem-js/reference/classes/task_batch.Batch.md rename to src/pages/docs/golem-js/reference/classes/work_batch.Batch.md index 15393d0a8..ff8eb692e 100644 --- a/src/pages/docs/golem-js/reference/classes/task_batch.Batch.md +++ b/src/pages/docs/golem-js/reference/classes/work_batch.Batch.md @@ -6,31 +6,31 @@ type: "JS API Reference" --- # Class: Batch -[task/batch](../modules/task_batch).Batch +[work/batch](../modules/work_batch).Batch ## Table of contents ### Constructors -- [constructor](task_batch.Batch#constructor) +- [constructor](work_batch.Batch#constructor) ### Methods -- [create](task_batch.Batch#create) -- [run](task_batch.Batch#run) -- [transfer](task_batch.Batch#transfer) -- [uploadFile](task_batch.Batch#uploadfile) -- [uploadJson](task_batch.Batch#uploadjson) -- [uploadData](task_batch.Batch#uploaddata) -- [downloadFile](task_batch.Batch#downloadfile) -- [end](task_batch.Batch#end) -- [endStream](task_batch.Batch#endstream) +- [create](work_batch.Batch#create) +- [run](work_batch.Batch#run) +- [transfer](work_batch.Batch#transfer) +- [uploadFile](work_batch.Batch#uploadfile) +- [uploadJson](work_batch.Batch#uploadjson) +- [uploadData](work_batch.Batch#uploaddata) +- [downloadFile](work_batch.Batch#downloadfile) +- [end](work_batch.Batch#end) +- [endStream](work_batch.Batch#endstream) ## Constructors ### constructor -• **new Batch**(`activity`, `storageProvider`, `logger`): [`Batch`](task_batch.Batch) +• **new Batch**(`activity`, `storageProvider`, `logger`): [`Batch`](work_batch.Batch) #### Parameters @@ -42,17 +42,17 @@ type: "JS API Reference" #### Returns -[`Batch`](task_batch.Batch) +[`Batch`](work_batch.Batch) #### Defined in -[src/task/batch.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/batch.ts#L15) +[src/work/batch.ts:15](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/batch.ts#L15) ## Methods ### create -▸ **create**(`activity`, `storageProvider`, `logger?`): [`Batch`](task_batch.Batch) +▸ **create**(`activity`, `storageProvider`, `logger?`): [`Batch`](work_batch.Batch) #### Parameters @@ -64,17 +64,17 @@ type: "JS API Reference" #### Returns -[`Batch`](task_batch.Batch) +[`Batch`](work_batch.Batch) #### Defined in -[src/task/batch.ts:11](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/batch.ts#L11) +[src/work/batch.ts:11](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/batch.ts#L11) ___ ### run -▸ **run**(`commandLine`): [`Batch`](task_batch.Batch) +▸ **run**(`commandLine`): [`Batch`](work_batch.Batch) Execute a command on provider using a shell (/bin/sh). @@ -86,13 +86,13 @@ Execute a command on provider using a shell (/bin/sh). #### Returns -[`Batch`](task_batch.Batch) +[`Batch`](work_batch.Batch) #### Defined in -[src/task/batch.ts:28](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/batch.ts#L28) +[src/work/batch.ts:28](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/batch.ts#L28) -▸ **run**(`executable`, `args`): [`Batch`](task_batch.Batch) +▸ **run**(`executable`, `args`): [`Batch`](work_batch.Batch) Execute an executable on provider. @@ -105,17 +105,17 @@ Execute an executable on provider. #### Returns -[`Batch`](task_batch.Batch) +[`Batch`](work_batch.Batch) #### Defined in -[src/task/batch.ts:36](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/batch.ts#L36) +[src/work/batch.ts:36](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/batch.ts#L36) ___ ### transfer -▸ **transfer**(`from`, `to`): [`Batch`](task_batch.Batch) +▸ **transfer**(`from`, `to`): [`Batch`](work_batch.Batch) #### Parameters @@ -126,17 +126,17 @@ ___ #### Returns -[`Batch`](task_batch.Batch) +[`Batch`](work_batch.Batch) #### Defined in -[src/task/batch.ts:47](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/batch.ts#L47) +[src/work/batch.ts:47](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/batch.ts#L47) ___ ### uploadFile -▸ **uploadFile**(`src`, `dst`): [`Batch`](task_batch.Batch) +▸ **uploadFile**(`src`, `dst`): [`Batch`](work_batch.Batch) #### Parameters @@ -147,17 +147,17 @@ ___ #### Returns -[`Batch`](task_batch.Batch) +[`Batch`](work_batch.Batch) #### Defined in -[src/task/batch.ts:52](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/batch.ts#L52) +[src/work/batch.ts:52](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/batch.ts#L52) ___ ### uploadJson -▸ **uploadJson**(`json`, `dst`): [`Batch`](task_batch.Batch) +▸ **uploadJson**(`json`, `dst`): [`Batch`](work_batch.Batch) #### Parameters @@ -168,17 +168,17 @@ ___ #### Returns -[`Batch`](task_batch.Batch) +[`Batch`](work_batch.Batch) #### Defined in -[src/task/batch.ts:57](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/batch.ts#L57) +[src/work/batch.ts:57](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/batch.ts#L57) ___ ### uploadData -▸ **uploadData**(`data`, `dst`): [`Batch`](task_batch.Batch) +▸ **uploadData**(`data`, `dst`): [`Batch`](work_batch.Batch) #### Parameters @@ -189,17 +189,17 @@ ___ #### Returns -[`Batch`](task_batch.Batch) +[`Batch`](work_batch.Batch) #### Defined in -[src/task/batch.ts:63](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/batch.ts#L63) +[src/work/batch.ts:63](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/batch.ts#L63) ___ ### downloadFile -▸ **downloadFile**(`src`, `dst`): [`Batch`](task_batch.Batch) +▸ **downloadFile**(`src`, `dst`): [`Batch`](work_batch.Batch) #### Parameters @@ -210,11 +210,11 @@ ___ #### Returns -[`Batch`](task_batch.Batch) +[`Batch`](work_batch.Batch) #### Defined in -[src/task/batch.ts:68](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/batch.ts#L68) +[src/work/batch.ts:68](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/batch.ts#L68) ___ @@ -222,7 +222,7 @@ ___ ▸ **end**(): `Promise`\<[`Result`](activity_results.Result)\<`any`\>[]\> -Executes the batch of commands added via [run](task_batch.Batch#run) returning result for each of the steps. +Executes the batch of commands added via [run](work_batch.Batch#run) returning result for each of the steps. #### Returns @@ -230,7 +230,7 @@ Executes the batch of commands added via [run](task_batch.Batch#run) returning r #### Defined in -[src/task/batch.ts:76](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/batch.ts#L76) +[src/work/batch.ts:76](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/batch.ts#L76) ___ @@ -244,4 +244,4 @@ ___ #### Defined in -[src/task/batch.ts:141](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/batch.ts#L141) +[src/work/batch.ts:141](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/batch.ts#L141) diff --git a/src/pages/docs/golem-js/reference/classes/work_error.GolemWorkError.md b/src/pages/docs/golem-js/reference/classes/work_error.GolemWorkError.md new file mode 100644 index 000000000..45f4e5e9b --- /dev/null +++ b/src/pages/docs/golem-js/reference/classes/work_error.GolemWorkError.md @@ -0,0 +1,137 @@ +--- +title: "Class GolemWorkError" +pageTitle: "Class GolemWorkError - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Class GolemWorkError within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Class: GolemWorkError + +[work/error](../modules/work_error).GolemWorkError + +Module specific errors - Market, Work, Payment. +Each of the major modules will have its own domain specific root error type, +additionally containing an error code specific to a given subdomain + +## Hierarchy + +- [`GolemModuleError`](error_golem_error.GolemModuleError) + + ↳ **`GolemWorkError`** + +## Table of contents + +### Constructors + +- [constructor](work_error.GolemWorkError#constructor) + +### Properties + +- [code](work_error.GolemWorkError#code) +- [previous](work_error.GolemWorkError#previous) + +### Methods + +- [getAgreement](work_error.GolemWorkError#getagreement) +- [getActivity](work_error.GolemWorkError#getactivity) +- [getProvider](work_error.GolemWorkError#getprovider) + +## Constructors + +### constructor + +• **new GolemWorkError**(`message`, `code`, `agreement?`, `activity?`, `provider?`, `previous?`): [`GolemWorkError`](work_error.GolemWorkError) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `code` | [`WorkErrorCode`](../enums/work_error.WorkErrorCode) | +| `agreement?` | `Agreement` | +| `activity?` | [`Activity`](activity_activity.Activity) | +| `provider?` | [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) | +| `previous?` | `Error` | + +#### Returns + +[`GolemWorkError`](work_error.GolemWorkError) + +#### Overrides + +[GolemModuleError](error_golem_error.GolemModuleError).[constructor](error_golem_error.GolemModuleError#constructor) + +#### Defined in + +[src/work/error.ts:20](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L20) + +## Properties + +### code + +• **code**: [`WorkErrorCode`](../enums/work_error.WorkErrorCode) + +#### Inherited from + +[GolemModuleError](error_golem_error.GolemModuleError).[code](error_golem_error.GolemModuleError#code) + +#### Defined in + +[src/work/error.ts:22](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L22) + +___ + +### previous + +• `Optional` **previous**: `Error` + +The previous error, if any, that led to this error. + +#### Inherited from + +[GolemModuleError](error_golem_error.GolemModuleError).[previous](error_golem_error.GolemModuleError#previous) + +#### Defined in + +[src/work/error.ts:26](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L26) + +## Methods + +### getAgreement + +▸ **getAgreement**(): `undefined` \| `Agreement` + +#### Returns + +`undefined` \| `Agreement` + +#### Defined in + +[src/work/error.ts:33](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L33) + +___ + +### getActivity + +▸ **getActivity**(): `undefined` \| [`Activity`](activity_activity.Activity) + +#### Returns + +`undefined` \| [`Activity`](activity_activity.Activity) + +#### Defined in + +[src/work/error.ts:36](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L36) + +___ + +### getProvider + +▸ **getProvider**(): `undefined` \| [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) + +#### Returns + +`undefined` \| [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) + +#### Defined in + +[src/work/error.ts:39](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L39) diff --git a/src/pages/docs/golem-js/reference/classes/task_process.RemoteProcess.md b/src/pages/docs/golem-js/reference/classes/work_process.RemoteProcess.md similarity index 65% rename from src/pages/docs/golem-js/reference/classes/task_process.RemoteProcess.md rename to src/pages/docs/golem-js/reference/classes/work_process.RemoteProcess.md index 111b3be07..9ac6c34ec 100644 --- a/src/pages/docs/golem-js/reference/classes/task_process.RemoteProcess.md +++ b/src/pages/docs/golem-js/reference/classes/work_process.RemoteProcess.md @@ -6,30 +6,30 @@ type: "JS API Reference" --- # Class: RemoteProcess -[task/process](../modules/task_process).RemoteProcess +[work/process](../modules/work_process).RemoteProcess -RemoteProcess class representing the process spawned on the provider by WorkContext.spawn +RemoteProcess class representing the process spawned on the provider by WorkContext.runAndStream ## Table of contents ### Constructors -- [constructor](task_process.RemoteProcess#constructor) +- [constructor](work_process.RemoteProcess#constructor) ### Properties -- [stdout](task_process.RemoteProcess#stdout) -- [stderr](task_process.RemoteProcess#stderr) +- [stdout](work_process.RemoteProcess#stdout) +- [stderr](work_process.RemoteProcess#stderr) ### Methods -- [waitForExit](task_process.RemoteProcess#waitforexit) +- [waitForExit](work_process.RemoteProcess#waitforexit) ## Constructors ### constructor -• **new RemoteProcess**(`streamOfActivityResults`, `activity`): [`RemoteProcess`](task_process.RemoteProcess) +• **new RemoteProcess**(`streamOfActivityResults`, `activity`): [`RemoteProcess`](work_process.RemoteProcess) #### Parameters @@ -40,11 +40,11 @@ RemoteProcess class representing the process spawned on the provider by WorkCont #### Returns -[`RemoteProcess`](task_process.RemoteProcess) +[`RemoteProcess`](work_process.RemoteProcess) #### Defined in -[src/task/process.ts:23](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/process.ts#L23) +[src/work/process.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/process.ts#L27) ## Properties @@ -56,7 +56,7 @@ Stream connected to stdout from provider process #### Defined in -[src/task/process.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/process.ts#L16) +[src/work/process.ts:17](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/process.ts#L17) ___ @@ -68,7 +68,7 @@ Stream connected to stderr from provider process #### Defined in -[src/task/process.ts:20](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/process.ts#L20) +[src/work/process.ts:21](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/process.ts#L21) ## Methods @@ -91,4 +91,4 @@ If the timeout is reached, the return promise will be rejected. #### Defined in -[src/task/process.ts:39](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/process.ts#L39) +[src/work/process.ts:43](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/process.ts#L43) diff --git a/src/pages/docs/golem-js/reference/classes/work_work.WorkContext.md b/src/pages/docs/golem-js/reference/classes/work_work.WorkContext.md new file mode 100644 index 000000000..c688484d4 --- /dev/null +++ b/src/pages/docs/golem-js/reference/classes/work_work.WorkContext.md @@ -0,0 +1,468 @@ +--- +title: "Class WorkContext" +pageTitle: "Class WorkContext - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Class WorkContext within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Class: WorkContext + +[work/work](../modules/work_work).WorkContext + +Groups most common operations that the requestors might need to implement their workflows + +## Table of contents + +### Constructors + +- [constructor](work_work.WorkContext#constructor) + +### Properties + +- [provider](work_work.WorkContext#provider) +- [activity](work_work.WorkContext#activity) + +### Methods + +- [before](work_work.WorkContext#before) +- [run](work_work.WorkContext#run) +- [spawn](work_work.WorkContext#spawn) +- [runAndStream](work_work.WorkContext#runandstream) +- [transfer](work_work.WorkContext#transfer) +- [uploadFile](work_work.WorkContext#uploadfile) +- [uploadJson](work_work.WorkContext#uploadjson) +- [uploadData](work_work.WorkContext#uploaddata) +- [downloadFile](work_work.WorkContext#downloadfile) +- [downloadData](work_work.WorkContext#downloaddata) +- [downloadJson](work_work.WorkContext#downloadjson) +- [beginBatch](work_work.WorkContext#beginbatch) +- [getWebsocketUri](work_work.WorkContext#getwebsocketuri) +- [getIp](work_work.WorkContext#getip) +- [createTcpProxy](work_work.WorkContext#createtcpproxy) +- [getState](work_work.WorkContext#getstate) + +## Constructors + +### constructor + +• **new WorkContext**(`activity`, `options`): [`WorkContext`](work_work.WorkContext) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `activity` | [`Activity`](activity_activity.Activity) | +| `options` | [`WorkOptions`](../interfaces/work_work.WorkOptions) | + +#### Returns + +[`WorkContext`](work_work.WorkContext) + +#### Defined in + +[src/work/work.ts:61](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L61) + +## Properties + +### provider + +• `Readonly` **provider**: [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo) + +#### Defined in + +[src/work/work.ts:55](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L55) + +___ + +### activity + +• `Readonly` **activity**: [`Activity`](activity_activity.Activity) + +#### Defined in + +[src/work/work.ts:62](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L62) + +## Methods + +### before + +▸ **before**(): `Promise`\<`void` \| [`Result`](activity_results.Result)\<`any`\>[]\> + +#### Returns + +`Promise`\<`void` \| [`Result`](activity_results.Result)\<`any`\>[]\> + +#### Defined in + +[src/work/work.ts:75](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L75) + +___ + +### run + +▸ **run**(`commandLine`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +Execute a command on provider using a shell (/bin/sh). + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `commandLine` | `string` | Shell command to execute. | +| `options?` | [`CommandOptions`](../interfaces/work_work.CommandOptions) | Additional run options. | + +#### Returns + +`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +#### Defined in + +[src/work/work.ts:174](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L174) + +▸ **run**(`executable`, `args`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +Execute an executable on provider. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `executable` | `string` | Executable to run. | +| `args` | `string`[] | Executable arguments. | +| `options?` | [`CommandOptions`](../interfaces/work_work.CommandOptions) | Additional run options. | + +#### Returns + +`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +#### Defined in + +[src/work/work.ts:183](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L183) + +___ + +### spawn + +▸ **spawn**(`commandLine`, `options?`): `Promise`\<[`RemoteProcess`](work_process.RemoteProcess)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `commandLine` | `string` | +| `options?` | `Omit`\<[`CommandOptions`](../interfaces/work_work.CommandOptions), ``"capture"``\> | + +#### Returns + +`Promise`\<[`RemoteProcess`](work_process.RemoteProcess)\> + +**`Deprecated`** + +Use [WorkContext.runAndStream](work_work.WorkContext#runandstream) instead + +#### Defined in + +[src/work/work.ts:201](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L201) + +▸ **spawn**(`executable`, `args`, `options?`): `Promise`\<[`RemoteProcess`](work_process.RemoteProcess)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `executable` | `string` | +| `args` | `string`[] | +| `options?` | [`CommandOptions`](../interfaces/work_work.CommandOptions) | + +#### Returns + +`Promise`\<[`RemoteProcess`](work_process.RemoteProcess)\> + +**`Deprecated`** + +Use [WorkContext.runAndStream](work_work.WorkContext#runandstream) instead + +#### Defined in + +[src/work/work.ts:203](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L203) + +___ + +### runAndStream + +▸ **runAndStream**(`commandLine`, `options?`): `Promise`\<[`RemoteProcess`](work_process.RemoteProcess)\> + +Run an executable on provider and return [RemoteProcess](work_process.RemoteProcess) that will allow streaming + that contain stdout and stderr as Readable + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `commandLine` | `string` | Shell command to execute. | +| `options?` | `Omit`\<[`CommandOptions`](../interfaces/work_work.CommandOptions), ``"capture"``\> | Additional run options. | + +#### Returns + +`Promise`\<[`RemoteProcess`](work_process.RemoteProcess)\> + +#### Defined in + +[src/work/work.ts:220](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L220) + +▸ **runAndStream**(`executable`, `args`, `options?`): `Promise`\<[`RemoteProcess`](work_process.RemoteProcess)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `executable` | `string` | Executable to run. | +| `args` | `string`[] | Executable arguments. | +| `options?` | [`CommandOptions`](../interfaces/work_work.CommandOptions) | Additional run options. | + +#### Returns + +`Promise`\<[`RemoteProcess`](work_process.RemoteProcess)\> + +#### Defined in + +[src/work/work.ts:226](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L226) + +___ + +### transfer + +▸ **transfer**(`from`, `to`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +Generic transfer command, requires the user to provide a publicly readable transfer source + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `from` | `string` | publicly available resource for reading. Supported protocols: file, http, ftp or gftp | +| `to` | `string` | file path | +| `options?` | [`CommandOptions`](../interfaces/work_work.CommandOptions) | Additional run options. | + +#### Returns + +`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +#### Defined in + +[src/work/work.ts:268](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L268) + +___ + +### uploadFile + +▸ **uploadFile**(`src`, `dst`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `src` | `string` | +| `dst` | `string` | +| `options?` | [`CommandOptions`](../interfaces/work_work.CommandOptions) | + +#### Returns + +`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +#### Defined in + +[src/work/work.ts:273](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L273) + +___ + +### uploadJson + +▸ **uploadJson**(`json`, `dst`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `json` | `any` | +| `dst` | `string` | +| `options?` | [`CommandOptions`](../interfaces/work_work.CommandOptions) | + +#### Returns + +`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +#### Defined in + +[src/work/work.ts:279](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L279) + +___ + +### uploadData + +▸ **uploadData**(`data`, `dst`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `Uint8Array` | +| `dst` | `string` | +| `options?` | [`CommandOptions`](../interfaces/work_work.CommandOptions) | + +#### Returns + +`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +#### Defined in + +[src/work/work.ts:285](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L285) + +___ + +### downloadFile + +▸ **downloadFile**(`src`, `dst`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `src` | `string` | +| `dst` | `string` | +| `options?` | [`CommandOptions`](../interfaces/work_work.CommandOptions) | + +#### Returns + +`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +#### Defined in + +[src/work/work.ts:290](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L290) + +___ + +### downloadData + +▸ **downloadData**(`src`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`Uint8Array`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `src` | `string` | +| `options?` | [`CommandOptions`](../interfaces/work_work.CommandOptions) | + +#### Returns + +`Promise`\<[`Result`](activity_results.Result)\<`Uint8Array`\>\> + +#### Defined in + +[src/work/work.ts:295](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L295) + +___ + +### downloadJson + +▸ **downloadJson**(`src`, `options?`): `Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `src` | `string` | +| `options?` | [`CommandOptions`](../interfaces/work_work.CommandOptions) | + +#### Returns + +`Promise`\<[`Result`](activity_results.Result)\<`any`\>\> + +#### Defined in + +[src/work/work.ts:300](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L300) + +___ + +### beginBatch + +▸ **beginBatch**(): [`Batch`](work_batch.Batch) + +#### Returns + +[`Batch`](work_batch.Batch) + +#### Defined in + +[src/work/work.ts:316](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L316) + +___ + +### getWebsocketUri + +▸ **getWebsocketUri**(`port`): `string` + +Provides a WebSocket URI that allows communicating with a remote process listening on the target port + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `port` | `number` | The port number used by the service running within an activity on the provider | + +#### Returns + +`string` + +#### Defined in + +[src/work/work.ts:325](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L325) + +___ + +### getIp + +▸ **getIp**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/work/work.ts:338](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L338) + +___ + +### createTcpProxy + +▸ **createTcpProxy**(`portOnProvider`): [`TcpProxy`](network_tcpProxy.TcpProxy) + +Creates a new TCP proxy that will allow tunnelling the TPC traffic from the provider via the requestor + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `portOnProvider` | `number` | The port that the service running on the provider is listening to | + +#### Returns + +[`TcpProxy`](network_tcpProxy.TcpProxy) + +#### Defined in + +[src/work/work.ts:355](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L355) + +___ + +### getState + +▸ **getState**(): `Promise`\<[`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)\> + +#### Returns + +`Promise`\<[`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)\> + +#### Defined in + +[src/work/work.ts:365](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L365) diff --git a/src/pages/docs/golem-js/reference/enums/activity_activity.ActivityStateEnum.md b/src/pages/docs/golem-js/reference/enums/activity_activity.ActivityStateEnum.md index 5c8d68b5d..b65970ffb 100644 --- a/src/pages/docs/golem-js/reference/enums/activity_activity.ActivityStateEnum.md +++ b/src/pages/docs/golem-js/reference/enums/activity_activity.ActivityStateEnum.md @@ -27,7 +27,7 @@ type: "JS API Reference" #### Defined in -[src/activity/activity.ts:14](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L14) +[src/activity/activity.ts:22](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L22) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -[src/activity/activity.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L15) +[src/activity/activity.ts:23](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L23) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[src/activity/activity.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L16) +[src/activity/activity.ts:24](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L24) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[src/activity/activity.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L17) +[src/activity/activity.ts:25](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L25) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[src/activity/activity.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L18) +[src/activity/activity.ts:26](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L26) ___ @@ -77,4 +77,4 @@ ___ #### Defined in -[src/activity/activity.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L19) +[src/activity/activity.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L27) diff --git a/src/pages/docs/golem-js/reference/enums/experimental_job_job.JobState.md b/src/pages/docs/golem-js/reference/enums/experimental_job_job.JobState.md new file mode 100644 index 000000000..4919b9d19 --- /dev/null +++ b/src/pages/docs/golem-js/reference/enums/experimental_job_job.JobState.md @@ -0,0 +1,80 @@ +--- +title: "Enum JobState" +pageTitle: "Enum JobState - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Enum JobState within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Enumeration: JobState + +[experimental/job/job](../modules/experimental_job_job).JobState + +## Table of contents + +### Enumeration Members + +- [New](experimental_job_job.JobState#new) +- [Queued](experimental_job_job.JobState#queued) +- [Pending](experimental_job_job.JobState#pending) +- [Done](experimental_job_job.JobState#done) +- [Retry](experimental_job_job.JobState#retry) +- [Rejected](experimental_job_job.JobState#rejected) + +## Enumeration Members + +### New + +• **New** = ``"new"`` + +#### Defined in + +[src/experimental/job/job.ts:20](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L20) + +___ + +### Queued + +• **Queued** = ``"queued"`` + +#### Defined in + +[src/experimental/job/job.ts:21](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L21) + +___ + +### Pending + +• **Pending** = ``"pending"`` + +#### Defined in + +[src/experimental/job/job.ts:22](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L22) + +___ + +### Done + +• **Done** = ``"done"`` + +#### Defined in + +[src/experimental/job/job.ts:23](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L23) + +___ + +### Retry + +• **Retry** = ``"retry"`` + +#### Defined in + +[src/experimental/job/job.ts:24](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L24) + +___ + +### Rejected + +• **Rejected** = ``"rejected"`` + +#### Defined in + +[src/experimental/job/job.ts:25](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L25) diff --git a/src/pages/docs/golem-js/reference/enums/market_error.MarketErrorCode.md b/src/pages/docs/golem-js/reference/enums/market_error.MarketErrorCode.md index d9a0591cc..c4fc20448 100644 --- a/src/pages/docs/golem-js/reference/enums/market_error.MarketErrorCode.md +++ b/src/pages/docs/golem-js/reference/enums/market_error.MarketErrorCode.md @@ -27,98 +27,98 @@ type: "JS API Reference" ### ServiceNotInitialized -• **ServiceNotInitialized** = ``0`` +• **ServiceNotInitialized** = ``"ServiceNotInitialized"`` #### Defined in -[src/market/error.ts:5](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L5) +[src/market/error.ts:5](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L5) ___ ### MissingAllocation -• **MissingAllocation** = ``1`` +• **MissingAllocation** = ``"MissingAllocation"`` #### Defined in -[src/market/error.ts:6](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L6) +[src/market/error.ts:6](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L6) ___ ### SubscriptionFailed -• **SubscriptionFailed** = ``2`` +• **SubscriptionFailed** = ``"SubscriptionFailed"`` #### Defined in -[src/market/error.ts:7](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L7) +[src/market/error.ts:7](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L7) ___ ### InvalidProposal -• **InvalidProposal** = ``3`` +• **InvalidProposal** = ``"InvalidProposal"`` #### Defined in -[src/market/error.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L8) +[src/market/error.ts:8](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L8) ___ ### ProposalResponseFailed -• **ProposalResponseFailed** = ``4`` +• **ProposalResponseFailed** = ``"ProposalResponseFailed"`` #### Defined in -[src/market/error.ts:9](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L9) +[src/market/error.ts:9](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L9) ___ ### ProposalRejectionFailed -• **ProposalRejectionFailed** = ``5`` +• **ProposalRejectionFailed** = ``"ProposalRejectionFailed"`` #### Defined in -[src/market/error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L10) +[src/market/error.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L10) ___ ### DemandExpired -• **DemandExpired** = ``6`` +• **DemandExpired** = ``"DemandExpired"`` #### Defined in -[src/market/error.ts:11](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L11) +[src/market/error.ts:11](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L11) ___ ### AgreementTerminationFailed -• **AgreementTerminationFailed** = ``7`` +• **AgreementTerminationFailed** = ``"AgreementTerminationFailed"`` #### Defined in -[src/market/error.ts:12](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L12) +[src/market/error.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L12) ___ ### AgreementCreationFailed -• **AgreementCreationFailed** = ``8`` +• **AgreementCreationFailed** = ``"AgreementCreationFailed"`` #### Defined in -[src/market/error.ts:13](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L13) +[src/market/error.ts:13](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L13) ___ ### AgreementApprovalFailed -• **AgreementApprovalFailed** = ``9`` +• **AgreementApprovalFailed** = ``"AgreementApprovalFailed"`` #### Defined in -[src/market/error.ts:14](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/error.ts#L14) +[src/market/error.ts:14](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/error.ts#L14) diff --git a/src/pages/docs/golem-js/reference/enums/network_error.NetworkErrorCode.md b/src/pages/docs/golem-js/reference/enums/network_error.NetworkErrorCode.md index b1f2c94aa..ba61ee4d2 100644 --- a/src/pages/docs/golem-js/reference/enums/network_error.NetworkErrorCode.md +++ b/src/pages/docs/golem-js/reference/enums/network_error.NetworkErrorCode.md @@ -26,88 +26,88 @@ type: "JS API Reference" ### ServiceNotInitialized -• **ServiceNotInitialized** = ``0`` +• **ServiceNotInitialized** = ``"ServiceNotInitialized"`` #### Defined in -[src/network/error.ts:5](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/error.ts#L5) +[src/network/error.ts:5](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/error.ts#L5) ___ ### NetworkSetupMissing -• **NetworkSetupMissing** = ``1`` +• **NetworkSetupMissing** = ``"NetworkSetupMissing"`` #### Defined in -[src/network/error.ts:6](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/error.ts#L6) +[src/network/error.ts:6](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/error.ts#L6) ___ ### NetworkCreationFailed -• **NetworkCreationFailed** = ``2`` +• **NetworkCreationFailed** = ``"NetworkCreationFailed"`` #### Defined in -[src/network/error.ts:7](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/error.ts#L7) +[src/network/error.ts:7](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/error.ts#L7) ___ ### NoAddressesAvailable -• **NoAddressesAvailable** = ``3`` +• **NoAddressesAvailable** = ``"NoAddressesAvailable"`` #### Defined in -[src/network/error.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/error.ts#L8) +[src/network/error.ts:8](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/error.ts#L8) ___ ### AddressOutOfRange -• **AddressOutOfRange** = ``4`` +• **AddressOutOfRange** = ``"AddressOutOfRange"`` #### Defined in -[src/network/error.ts:9](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/error.ts#L9) +[src/network/error.ts:9](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/error.ts#L9) ___ ### AddressAlreadyAssigned -• **AddressAlreadyAssigned** = ``5`` +• **AddressAlreadyAssigned** = ``"AddressAlreadyAssigned"`` #### Defined in -[src/network/error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/error.ts#L10) +[src/network/error.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/error.ts#L10) ___ ### NodeAddingFailed -• **NodeAddingFailed** = ``6`` +• **NodeAddingFailed** = ``"NodeAddingFailed"`` #### Defined in -[src/network/error.ts:11](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/error.ts#L11) +[src/network/error.ts:11](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/error.ts#L11) ___ ### NodeRemovalFailed -• **NodeRemovalFailed** = ``7`` +• **NodeRemovalFailed** = ``"NodeRemovalFailed"`` #### Defined in -[src/network/error.ts:12](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/error.ts#L12) +[src/network/error.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/error.ts#L12) ___ ### NetworkRemovalFailed -• **NetworkRemovalFailed** = ``8`` +• **NetworkRemovalFailed** = ``"NetworkRemovalFailed"`` #### Defined in -[src/network/error.ts:13](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/error.ts#L13) +[src/network/error.ts:13](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/error.ts#L13) diff --git a/src/pages/docs/golem-js/reference/enums/payment_error.PaymentErrorCode.md b/src/pages/docs/golem-js/reference/enums/payment_error.PaymentErrorCode.md index 3cec05d57..19705e660 100644 --- a/src/pages/docs/golem-js/reference/enums/payment_error.PaymentErrorCode.md +++ b/src/pages/docs/golem-js/reference/enums/payment_error.PaymentErrorCode.md @@ -28,108 +28,108 @@ type: "JS API Reference" ### AllocationCreationFailed -• **AllocationCreationFailed** = ``0`` +• **AllocationCreationFailed** = ``"AllocationCreationFailed"`` #### Defined in -[src/payment/error.ts:6](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L6) +[src/payment/error.ts:6](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L6) ___ ### MissingAllocation -• **MissingAllocation** = ``1`` +• **MissingAllocation** = ``"MissingAllocation"`` #### Defined in -[src/payment/error.ts:7](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L7) +[src/payment/error.ts:7](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L7) ___ ### PaymentProcessNotInitialized -• **PaymentProcessNotInitialized** = ``2`` +• **PaymentProcessNotInitialized** = ``"PaymentProcessNotInitialized"`` #### Defined in -[src/payment/error.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L8) +[src/payment/error.ts:8](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L8) ___ ### AllocationReleaseFailed -• **AllocationReleaseFailed** = ``3`` +• **AllocationReleaseFailed** = ``"AllocationReleaseFailed"`` #### Defined in -[src/payment/error.ts:9](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L9) +[src/payment/error.ts:9](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L9) ___ ### InvoiceAcceptanceFailed -• **InvoiceAcceptanceFailed** = ``4`` +• **InvoiceAcceptanceFailed** = ``"InvoiceAcceptanceFailed"`` #### Defined in -[src/payment/error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L10) +[src/payment/error.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L10) ___ ### DebitNoteAcceptanceFailed -• **DebitNoteAcceptanceFailed** = ``5`` +• **DebitNoteAcceptanceFailed** = ``"DebitNoteAcceptanceFailed"`` #### Defined in -[src/payment/error.ts:11](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L11) +[src/payment/error.ts:11](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L11) ___ ### InvoiceRejectionFailed -• **InvoiceRejectionFailed** = ``6`` +• **InvoiceRejectionFailed** = ``"InvoiceRejectionFailed"`` #### Defined in -[src/payment/error.ts:12](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L12) +[src/payment/error.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L12) ___ ### DebitNoteRejectionFailed -• **DebitNoteRejectionFailed** = ``7`` +• **DebitNoteRejectionFailed** = ``"DebitNoteRejectionFailed"`` #### Defined in -[src/payment/error.ts:13](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L13) +[src/payment/error.ts:13](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L13) ___ ### PaymentStatusQueryFailed -• **PaymentStatusQueryFailed** = ``8`` +• **PaymentStatusQueryFailed** = ``"PaymentStatusQueryFailed"`` #### Defined in -[src/payment/error.ts:14](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L14) +[src/payment/error.ts:14](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L14) ___ ### AgreementAlreadyPaid -• **AgreementAlreadyPaid** = ``9`` +• **AgreementAlreadyPaid** = ``"AgreementAlreadyPaid"`` #### Defined in -[src/payment/error.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L15) +[src/payment/error.ts:15](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L15) ___ ### InvoiceAlreadyReceived -• **InvoiceAlreadyReceived** = ``10`` +• **InvoiceAlreadyReceived** = ``"InvoiceAlreadyReceived"`` #### Defined in -[src/payment/error.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/error.ts#L16) +[src/payment/error.ts:16](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/error.ts#L16) diff --git a/src/pages/docs/golem-js/reference/enums/task_error.WorkErrorCode.md b/src/pages/docs/golem-js/reference/enums/task_error.WorkErrorCode.md deleted file mode 100644 index 717faa69f..000000000 --- a/src/pages/docs/golem-js/reference/enums/task_error.WorkErrorCode.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: "Enum WorkErrorCode" -pageTitle: "Enum WorkErrorCode - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Enum WorkErrorCode within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Enumeration: WorkErrorCode - -[task/error](../modules/task_error).WorkErrorCode - -## Table of contents - -### Enumeration Members - -- [ServiceNotInitialized](task_error.WorkErrorCode#servicenotinitialized) -- [ScriptExecutionFailed](task_error.WorkErrorCode#scriptexecutionfailed) -- [ActivityDestroyingFailed](task_error.WorkErrorCode#activitydestroyingfailed) -- [ActivityResultsFetchingFailed](task_error.WorkErrorCode#activityresultsfetchingfailed) -- [ActivityCreationFailed](task_error.WorkErrorCode#activitycreationfailed) -- [TaskAddingFailed](task_error.WorkErrorCode#taskaddingfailed) -- [TaskExecutionFailed](task_error.WorkErrorCode#taskexecutionfailed) -- [TaskRejected](task_error.WorkErrorCode#taskrejected) -- [NetworkSetupMissing](task_error.WorkErrorCode#networksetupmissing) -- [ScriptInitializationFailed](task_error.WorkErrorCode#scriptinitializationfailed) -- [ActivityDeploymentFailed](task_error.WorkErrorCode#activitydeploymentfailed) -- [ActivityStatusQueryFailed](task_error.WorkErrorCode#activitystatusqueryfailed) - -## Enumeration Members - -### ServiceNotInitialized - -• **ServiceNotInitialized** = ``0`` - -#### Defined in - -[src/task/error.ts:6](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L6) - -___ - -### ScriptExecutionFailed - -• **ScriptExecutionFailed** = ``1`` - -#### Defined in - -[src/task/error.ts:7](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L7) - -___ - -### ActivityDestroyingFailed - -• **ActivityDestroyingFailed** = ``2`` - -#### Defined in - -[src/task/error.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L8) - -___ - -### ActivityResultsFetchingFailed - -• **ActivityResultsFetchingFailed** = ``3`` - -#### Defined in - -[src/task/error.ts:9](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L9) - -___ - -### ActivityCreationFailed - -• **ActivityCreationFailed** = ``4`` - -#### Defined in - -[src/task/error.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L10) - -___ - -### TaskAddingFailed - -• **TaskAddingFailed** = ``5`` - -#### Defined in - -[src/task/error.ts:11](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L11) - -___ - -### TaskExecutionFailed - -• **TaskExecutionFailed** = ``6`` - -#### Defined in - -[src/task/error.ts:12](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L12) - -___ - -### TaskRejected - -• **TaskRejected** = ``7`` - -#### Defined in - -[src/task/error.ts:13](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L13) - -___ - -### NetworkSetupMissing - -• **NetworkSetupMissing** = ``8`` - -#### Defined in - -[src/task/error.ts:14](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L14) - -___ - -### ScriptInitializationFailed - -• **ScriptInitializationFailed** = ``9`` - -#### Defined in - -[src/task/error.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L15) - -___ - -### ActivityDeploymentFailed - -• **ActivityDeploymentFailed** = ``10`` - -#### Defined in - -[src/task/error.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L16) - -___ - -### ActivityStatusQueryFailed - -• **ActivityStatusQueryFailed** = ``11`` - -#### Defined in - -[src/task/error.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/error.ts#L17) diff --git a/src/pages/docs/golem-js/reference/enums/task_task.TaskState.md b/src/pages/docs/golem-js/reference/enums/task_task.TaskState.md deleted file mode 100644 index b242cc821..000000000 --- a/src/pages/docs/golem-js/reference/enums/task_task.TaskState.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "Enum TaskState" -pageTitle: "Enum TaskState - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Enum TaskState within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Enumeration: TaskState - -[task/task](../modules/task_task).TaskState - -## Table of contents - -### Enumeration Members - -- [New](task_task.TaskState#new) -- [Queued](task_task.TaskState#queued) -- [Pending](task_task.TaskState#pending) -- [Done](task_task.TaskState#done) -- [Retry](task_task.TaskState#retry) -- [Rejected](task_task.TaskState#rejected) - -## Enumeration Members - -### New - -• **New** = ``"new"`` - -#### Defined in - -[src/task/task.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L8) - -___ - -### Queued - -• **Queued** = ``"queued"`` - -#### Defined in - -[src/task/task.ts:9](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L9) - -___ - -### Pending - -• **Pending** = ``"pending"`` - -#### Defined in - -[src/task/task.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L10) - -___ - -### Done - -• **Done** = ``"done"`` - -#### Defined in - -[src/task/task.ts:11](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L11) - -___ - -### Retry - -• **Retry** = ``"retry"`` - -#### Defined in - -[src/task/task.ts:12](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L12) - -___ - -### Rejected - -• **Rejected** = ``"rejected"`` - -#### Defined in - -[src/task/task.ts:13](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L13) diff --git a/src/pages/docs/golem-js/reference/enums/work_error.WorkErrorCode.md b/src/pages/docs/golem-js/reference/enums/work_error.WorkErrorCode.md new file mode 100644 index 000000000..0f25a5494 --- /dev/null +++ b/src/pages/docs/golem-js/reference/enums/work_error.WorkErrorCode.md @@ -0,0 +1,113 @@ +--- +title: "Enum WorkErrorCode" +pageTitle: "Enum WorkErrorCode - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Enum WorkErrorCode within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Enumeration: WorkErrorCode + +[work/error](../modules/work_error).WorkErrorCode + +## Table of contents + +### Enumeration Members + +- [ServiceNotInitialized](work_error.WorkErrorCode#servicenotinitialized) +- [ScriptExecutionFailed](work_error.WorkErrorCode#scriptexecutionfailed) +- [ActivityDestroyingFailed](work_error.WorkErrorCode#activitydestroyingfailed) +- [ActivityResultsFetchingFailed](work_error.WorkErrorCode#activityresultsfetchingfailed) +- [ActivityCreationFailed](work_error.WorkErrorCode#activitycreationfailed) +- [NetworkSetupMissing](work_error.WorkErrorCode#networksetupmissing) +- [ScriptInitializationFailed](work_error.WorkErrorCode#scriptinitializationfailed) +- [ActivityDeploymentFailed](work_error.WorkErrorCode#activitydeploymentfailed) +- [ActivityStatusQueryFailed](work_error.WorkErrorCode#activitystatusqueryfailed) + +## Enumeration Members + +### ServiceNotInitialized + +• **ServiceNotInitialized** = ``"ServiceNotInitialized"`` + +#### Defined in + +[src/work/error.ts:6](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L6) + +___ + +### ScriptExecutionFailed + +• **ScriptExecutionFailed** = ``"ScriptExecutionFailed"`` + +#### Defined in + +[src/work/error.ts:7](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L7) + +___ + +### ActivityDestroyingFailed + +• **ActivityDestroyingFailed** = ``"ActivityDestroyingFailed"`` + +#### Defined in + +[src/work/error.ts:8](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L8) + +___ + +### ActivityResultsFetchingFailed + +• **ActivityResultsFetchingFailed** = ``"ActivityResultsFetchingFailed"`` + +#### Defined in + +[src/work/error.ts:9](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L9) + +___ + +### ActivityCreationFailed + +• **ActivityCreationFailed** = ``"ActivityCreationFailed"`` + +#### Defined in + +[src/work/error.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L10) + +___ + +### NetworkSetupMissing + +• **NetworkSetupMissing** = ``"NetworkSetupMissing"`` + +#### Defined in + +[src/work/error.ts:11](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L11) + +___ + +### ScriptInitializationFailed + +• **ScriptInitializationFailed** = ``"ScriptInitializationFailed"`` + +#### Defined in + +[src/work/error.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L12) + +___ + +### ActivityDeploymentFailed + +• **ActivityDeploymentFailed** = ``"ActivityDeploymentFailed"`` + +#### Defined in + +[src/work/error.ts:13](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L13) + +___ + +### ActivityStatusQueryFailed + +• **ActivityStatusQueryFailed** = ``"ActivityStatusQueryFailed"`` + +#### Defined in + +[src/work/error.ts:14](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/error.ts#L14) diff --git a/src/pages/docs/golem-js/reference/interfaces/activity_activity.ActivityEvents.md b/src/pages/docs/golem-js/reference/interfaces/activity_activity.ActivityEvents.md new file mode 100644 index 000000000..60abec93e --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/activity_activity.ActivityEvents.md @@ -0,0 +1,123 @@ +--- +title: "Interface ActivityEvents" +pageTitle: "Interface ActivityEvents - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface ActivityEvents within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: ActivityEvents + +[activity/activity](../modules/activity_activity).ActivityEvents + +## Table of contents + +### Properties + +- [scriptSent](activity_activity.ActivityEvents#scriptsent) +- [scriptExecuted](activity_activity.ActivityEvents#scriptexecuted) +- [stateChanged](activity_activity.ActivityEvents#statechanged) +- [destroyed](activity_activity.ActivityEvents#destroyed) + +## Properties + +### scriptSent + +• **scriptSent**: (`details`: \{ `activityId`: `string` ; `agreementId`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.activityId` | `string` | +| `details.agreementId` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/activity/activity.ts:15](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L15) + +___ + +### scriptExecuted + +• **scriptExecuted**: (`details`: \{ `activityId`: `string` ; `agreementId`: `string` ; `success`: `boolean` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.activityId` | `string` | +| `details.agreementId` | `string` | +| `details.success` | `boolean` | + +##### Returns + +`void` + +#### Defined in + +[src/activity/activity.ts:16](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L16) + +___ + +### stateChanged + +• **stateChanged**: (`details`: \{ `id`: `string` ; `state`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.state` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/activity/activity.ts:17](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L17) + +___ + +### destroyed + +• **destroyed**: (`details`: \{ `id`: `string` ; `agreementId`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.agreementId` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/activity/activity.ts:18](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L18) diff --git a/src/pages/docs/golem-js/reference/interfaces/activity_activity.ActivityOptions.md b/src/pages/docs/golem-js/reference/interfaces/activity_activity.ActivityOptions.md index 0aa3845fd..ced25efae 100644 --- a/src/pages/docs/golem-js/reference/interfaces/activity_activity.ActivityOptions.md +++ b/src/pages/docs/golem-js/reference/interfaces/activity_activity.ActivityOptions.md @@ -8,12 +8,6 @@ type: "JS API Reference" [activity/activity](../modules/activity_activity).ActivityOptions -## Hierarchy - -- **`ActivityOptions`** - - ↳ [`TaskServiceOptions`](task_service.TaskServiceOptions) - ## Table of contents ### Properties @@ -22,7 +16,6 @@ type: "JS API Reference" - [activityExecuteTimeout](activity_activity.ActivityOptions#activityexecutetimeout) - [activityExeBatchResultPollIntervalSeconds](activity_activity.ActivityOptions#activityexebatchresultpollintervalseconds) - [logger](activity_activity.ActivityOptions#logger) -- [eventTarget](activity_activity.ActivityOptions#eventtarget) ## Properties @@ -34,7 +27,7 @@ timeout for sending and creating batch #### Defined in -[src/activity/activity.ts:28](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L28) +[src/activity/activity.ts:36](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L36) ___ @@ -46,7 +39,7 @@ timeout for executing batch #### Defined in -[src/activity/activity.ts:30](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L30) +[src/activity/activity.ts:38](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L38) ___ @@ -58,7 +51,7 @@ interval for fetching batch results while polling #### Defined in -[src/activity/activity.ts:32](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L32) +[src/activity/activity.ts:40](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L40) ___ @@ -70,16 +63,4 @@ Logger module #### Defined in -[src/activity/activity.ts:34](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L34) - -___ - -### eventTarget - -• `Optional` **eventTarget**: `EventTarget` - -Event Bus implements EventTarget - -#### Defined in - -[src/activity/activity.ts:36](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L36) +[src/activity/activity.ts:42](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L42) diff --git a/src/pages/docs/golem-js/reference/interfaces/activity_activity.ExeScriptRequest.md b/src/pages/docs/golem-js/reference/interfaces/activity_activity.ExeScriptRequest.md index a4430718c..dee13aa80 100644 --- a/src/pages/docs/golem-js/reference/interfaces/activity_activity.ExeScriptRequest.md +++ b/src/pages/docs/golem-js/reference/interfaces/activity_activity.ExeScriptRequest.md @@ -22,4 +22,4 @@ type: "JS API Reference" #### Defined in -[src/activity/activity.ts:23](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L23) +[src/activity/activity.ts:31](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/activity.ts#L31) diff --git a/src/pages/docs/golem-js/reference/interfaces/activity_factory.ActivityFactoryEvents.md b/src/pages/docs/golem-js/reference/interfaces/activity_factory.ActivityFactoryEvents.md new file mode 100644 index 000000000..e696b087d --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/activity_factory.ActivityFactoryEvents.md @@ -0,0 +1,41 @@ +--- +title: "Interface ActivityFactoryEvents" +pageTitle: "Interface ActivityFactoryEvents - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface ActivityFactoryEvents within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: ActivityFactoryEvents + +[activity/factory](../modules/activity_factory).ActivityFactoryEvents + +## Table of contents + +### Properties + +- [activityCreated](activity_factory.ActivityFactoryEvents#activitycreated) + +## Properties + +### activityCreated + +• **activityCreated**: (`details`: \{ `id`: `string` ; `agreementId`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.agreementId` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/activity/factory.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/factory.ts#L10) diff --git a/src/pages/docs/golem-js/reference/interfaces/activity_results.ResultData.md b/src/pages/docs/golem-js/reference/interfaces/activity_results.ResultData.md index 0fdb25512..cbc9640ee 100644 --- a/src/pages/docs/golem-js/reference/interfaces/activity_results.ResultData.md +++ b/src/pages/docs/golem-js/reference/interfaces/activity_results.ResultData.md @@ -41,7 +41,7 @@ Index of script command #### Defined in -[src/activity/results.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L10) +[src/activity/results.ts:8](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L8) ___ @@ -53,19 +53,19 @@ The datetime of the event on which the result was received #### Defined in -[src/activity/results.ts:12](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L12) +[src/activity/results.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L10) ___ ### result -• **result**: `ExeScriptCommandResultResultEnum` +• **result**: ``"Ok"`` \| ``"Error"`` If is success #### Defined in -[src/activity/results.ts:14](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L14) +[src/activity/results.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L12) ___ @@ -77,7 +77,7 @@ stdout of script command #### Defined in -[src/activity/results.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L16) +[src/activity/results.ts:14](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L14) ___ @@ -89,7 +89,7 @@ stderr of script command #### Defined in -[src/activity/results.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L18) +[src/activity/results.ts:16](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L16) ___ @@ -101,7 +101,7 @@ an error message if the result is not successful #### Defined in -[src/activity/results.ts:20](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L20) +[src/activity/results.ts:18](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L18) ___ @@ -113,7 +113,7 @@ Is batch of already finished #### Defined in -[src/activity/results.ts:22](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L22) +[src/activity/results.ts:20](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L20) ___ @@ -125,4 +125,4 @@ In case the command was related to upload or download, this will contain the tra #### Defined in -[src/activity/results.ts:25](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L25) +[src/activity/results.ts:23](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L23) diff --git a/src/pages/docs/golem-js/reference/interfaces/activity_results.RuntimeEventKind.md b/src/pages/docs/golem-js/reference/interfaces/activity_results.RuntimeEventKind.md index 22e8da1ca..c190bee8b 100644 --- a/src/pages/docs/golem-js/reference/interfaces/activity_results.RuntimeEventKind.md +++ b/src/pages/docs/golem-js/reference/interfaces/activity_results.RuntimeEventKind.md @@ -25,7 +25,7 @@ type: "JS API Reference" #### Defined in -[src/activity/results.ts:79](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L79) +[src/activity/results.ts:77](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L77) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[src/activity/results.ts:80](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L80) +[src/activity/results.ts:78](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L78) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[src/activity/results.ts:81](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L81) +[src/activity/results.ts:79](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L79) ___ @@ -55,4 +55,4 @@ ___ #### Defined in -[src/activity/results.ts:82](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L82) +[src/activity/results.ts:80](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L80) diff --git a/src/pages/docs/golem-js/reference/interfaces/activity_results.StreamingBatchEvent.md b/src/pages/docs/golem-js/reference/interfaces/activity_results.StreamingBatchEvent.md index 378667c51..483c3c6e9 100644 --- a/src/pages/docs/golem-js/reference/interfaces/activity_results.StreamingBatchEvent.md +++ b/src/pages/docs/golem-js/reference/interfaces/activity_results.StreamingBatchEvent.md @@ -25,7 +25,7 @@ type: "JS API Reference" #### Defined in -[src/activity/results.ts:72](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L72) +[src/activity/results.ts:70](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L70) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[src/activity/results.ts:73](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L73) +[src/activity/results.ts:71](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L71) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[src/activity/results.ts:74](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L74) +[src/activity/results.ts:72](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L72) ___ @@ -55,4 +55,4 @@ ___ #### Defined in -[src/activity/results.ts:75](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/results.ts#L75) +[src/activity/results.ts:73](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/activity/results.ts#L73) diff --git a/src/pages/docs/golem-js/reference/interfaces/agreement_agreement.AgreementEvents.md b/src/pages/docs/golem-js/reference/interfaces/agreement_agreement.AgreementEvents.md new file mode 100644 index 000000000..a8e6fd58f --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/agreement_agreement.AgreementEvents.md @@ -0,0 +1,97 @@ +--- +title: "Interface AgreementEvents" +pageTitle: "Interface AgreementEvents - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface AgreementEvents within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: AgreementEvents + +[agreement/agreement](../modules/agreement_agreement).AgreementEvents + +## Table of contents + +### Properties + +- [confirmed](agreement_agreement.AgreementEvents#confirmed) +- [rejected](agreement_agreement.AgreementEvents#rejected) +- [terminated](agreement_agreement.AgreementEvents#terminated) + +## Properties + +### confirmed + +• **confirmed**: (`details`: \{ `id`: `string` ; `provider`: [`ProviderInfo`](agreement_agreement.ProviderInfo) }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.provider` | [`ProviderInfo`](agreement_agreement.ProviderInfo) | + +##### Returns + +`void` + +#### Defined in + +[src/agreement/agreement.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/agreement.ts#L10) + +___ + +### rejected + +• **rejected**: (`details`: \{ `id`: `string` ; `provider`: [`ProviderInfo`](agreement_agreement.ProviderInfo) ; `reason`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.provider` | [`ProviderInfo`](agreement_agreement.ProviderInfo) | +| `details.reason` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/agreement/agreement.ts:11](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/agreement.ts#L11) + +___ + +### terminated + +• **terminated**: (`details`: \{ `id`: `string` ; `provider`: [`ProviderInfo`](agreement_agreement.ProviderInfo) ; `reason`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.provider` | [`ProviderInfo`](agreement_agreement.ProviderInfo) | +| `details.reason` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/agreement/agreement.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/agreement.ts#L12) diff --git a/src/pages/docs/golem-js/reference/interfaces/agreement_agreement.ProviderInfo.md b/src/pages/docs/golem-js/reference/interfaces/agreement_agreement.ProviderInfo.md index d3235f214..1a8893d66 100644 --- a/src/pages/docs/golem-js/reference/interfaces/agreement_agreement.ProviderInfo.md +++ b/src/pages/docs/golem-js/reference/interfaces/agreement_agreement.ProviderInfo.md @@ -24,7 +24,7 @@ type: "JS API Reference" #### Defined in -[src/agreement/agreement.ts:11](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/agreement.ts#L11) +[src/agreement/agreement.ts:15](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/agreement.ts#L15) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[src/agreement/agreement.ts:12](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/agreement.ts#L12) +[src/agreement/agreement.ts:16](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/agreement.ts#L16) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[src/agreement/agreement.ts:13](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/agreement.ts#L13) +[src/agreement/agreement.ts:17](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/agreement.ts#L17) diff --git a/src/pages/docs/golem-js/reference/interfaces/agreement_factory.AgreementFactoryEvents.md b/src/pages/docs/golem-js/reference/interfaces/agreement_factory.AgreementFactoryEvents.md new file mode 100644 index 000000000..621489c29 --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/agreement_factory.AgreementFactoryEvents.md @@ -0,0 +1,43 @@ +--- +title: "Interface AgreementFactoryEvents" +pageTitle: "Interface AgreementFactoryEvents - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface AgreementFactoryEvents within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: AgreementFactoryEvents + +[agreement/factory](../modules/agreement_factory).AgreementFactoryEvents + +## Table of contents + +### Properties + +- [agreementCreated](agreement_factory.AgreementFactoryEvents#agreementcreated) + +## Properties + +### agreementCreated + +• **agreementCreated**: (`details`: \{ `id`: `string` ; `provider`: [`ProviderInfo`](agreement_agreement.ProviderInfo) ; `validTo`: `string` ; `proposalId`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.provider` | [`ProviderInfo`](agreement_agreement.ProviderInfo) | +| `details.validTo` | `string` | +| `details.proposalId` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/agreement/factory.ts:9](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/factory.ts#L9) diff --git a/src/pages/docs/golem-js/reference/interfaces/agreement_service.AgreementDTO.md b/src/pages/docs/golem-js/reference/interfaces/agreement_service.AgreementDTO.md index c43b38944..d133322bc 100644 --- a/src/pages/docs/golem-js/reference/interfaces/agreement_service.AgreementDTO.md +++ b/src/pages/docs/golem-js/reference/interfaces/agreement_service.AgreementDTO.md @@ -23,7 +23,7 @@ type: "JS API Reference" #### Defined in -[src/agreement/service.ts:9](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/service.ts#L9) +[src/agreement/service.ts:9](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/service.ts#L9) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[src/agreement/service.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/service.ts#L10) +[src/agreement/service.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/service.ts#L10) diff --git a/src/pages/docs/golem-js/reference/interfaces/agreement_service.AgreementServiceOptions.md b/src/pages/docs/golem-js/reference/interfaces/agreement_service.AgreementServiceOptions.md index bf209e95e..7c3de0868 100644 --- a/src/pages/docs/golem-js/reference/interfaces/agreement_service.AgreementServiceOptions.md +++ b/src/pages/docs/golem-js/reference/interfaces/agreement_service.AgreementServiceOptions.md @@ -26,7 +26,6 @@ type: "JS API Reference" - [agreementRequestTimeout](agreement_service.AgreementServiceOptions#agreementrequesttimeout) - [agreementWaitingForApprovalTimeout](agreement_service.AgreementServiceOptions#agreementwaitingforapprovaltimeout) - [logger](agreement_service.AgreementServiceOptions#logger) -- [eventTarget](agreement_service.AgreementServiceOptions#eventtarget) ## Properties @@ -38,7 +37,7 @@ The selector used when choosing a provider from a pool of existing offers (from #### Defined in -[src/agreement/service.ts:22](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/service.ts#L22) +[src/agreement/service.ts:22](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/service.ts#L22) ___ @@ -50,7 +49,7 @@ The maximum number of events fetched in one request call #### Defined in -[src/agreement/service.ts:24](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/service.ts#L24) +[src/agreement/service.ts:24](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/service.ts#L24) ___ @@ -62,7 +61,7 @@ interval for fetching agreement events #### Defined in -[src/agreement/service.ts:26](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/service.ts#L26) +[src/agreement/service.ts:26](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/service.ts#L26) ___ @@ -74,13 +73,13 @@ The maximum number of agreements stored in the pool #### Defined in -[src/agreement/service.ts:28](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/service.ts#L28) +[src/agreement/service.ts:28](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/service.ts#L28) ___ ### yagnaOptions -• `Optional` **yagnaOptions**: [`YagnaOptions`](../modules/executor_executor#yagnaoptions) +• `Optional` **yagnaOptions**: [`YagnaOptions`](../modules/utils_yagna_yagnaApi#yagnaoptions) yagnaOptions @@ -90,7 +89,7 @@ AgreementOptions.yagnaOptions #### Defined in -[src/agreement/agreement.ts:34](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/agreement.ts#L34) +[src/agreement/agreement.ts:25](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/agreement.ts#L25) ___ @@ -106,7 +105,7 @@ AgreementOptions.agreementRequestTimeout #### Defined in -[src/agreement/agreement.ts:36](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/agreement.ts#L36) +[src/agreement/agreement.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/agreement.ts#L27) ___ @@ -122,7 +121,7 @@ AgreementOptions.agreementWaitingForApprovalTimeout #### Defined in -[src/agreement/agreement.ts:38](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/agreement.ts#L38) +[src/agreement/agreement.ts:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/agreement.ts#L29) ___ @@ -138,20 +137,4 @@ AgreementOptions.logger #### Defined in -[src/agreement/agreement.ts:40](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/agreement.ts#L40) - -___ - -### eventTarget - -• `Optional` **eventTarget**: `EventTarget` - -Event Bus implements EventTarget - -#### Inherited from - -AgreementOptions.eventTarget - -#### Defined in - -[src/agreement/agreement.ts:42](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/agreement.ts#L42) +[src/agreement/agreement.ts:31](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/agreement.ts#L31) diff --git a/src/pages/docs/golem-js/reference/interfaces/executor_events.TaskExecutorEventsDict.md b/src/pages/docs/golem-js/reference/interfaces/executor_events.TaskExecutorEventsDict.md deleted file mode 100644 index 6472362fc..000000000 --- a/src/pages/docs/golem-js/reference/interfaces/executor_events.TaskExecutorEventsDict.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "Interface TaskExecutorEventsDict" -pageTitle: "Interface TaskExecutorEventsDict - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Interface TaskExecutorEventsDict within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Interface: TaskExecutorEventsDict - -[executor/events](../modules/executor_events).TaskExecutorEventsDict - -This interface describes events emitted by `TaskExecutor` through `TaskExecutor.events` object. - -## Table of contents - -### Properties - -- [ready](executor_events.TaskExecutorEventsDict#ready) -- [beforeEnd](executor_events.TaskExecutorEventsDict#beforeend) -- [end](executor_events.TaskExecutorEventsDict#end) - -## Properties - -### ready - -• **ready**: () => `void` - -Fires when task executor is initialized and ready to be used. - -#### Type declaration - -▸ (): `void` - -Fires when task executor is initialized and ready to be used. - -##### Returns - -`void` - -#### Defined in - -[src/executor/events.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/events.ts#L8) - -___ - -### beforeEnd - -• **beforeEnd**: () => `void` - -Fires when task executor is about to shut down, immediately after TaskExecutor.shutdown() is called. - -#### Type declaration - -▸ (): `void` - -Fires when task executor is about to shut down, immediately after TaskExecutor.shutdown() is called. - -##### Returns - -`void` - -#### Defined in - -[src/executor/events.ts:14](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/events.ts#L14) - -___ - -### end - -• **end**: () => `void` - -Fires when task executor is completely terminated. - -#### Type declaration - -▸ (): `void` - -Fires when task executor is completely terminated. - -##### Returns - -`void` - -#### Defined in - -[src/executor/events.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/events.ts#L19) diff --git a/src/pages/docs/golem-js/reference/interfaces/job_job.JobEventsDict.md b/src/pages/docs/golem-js/reference/interfaces/experimental_job_job.JobEventsDict.md similarity index 56% rename from src/pages/docs/golem-js/reference/interfaces/job_job.JobEventsDict.md rename to src/pages/docs/golem-js/reference/interfaces/experimental_job_job.JobEventsDict.md index e6ff00501..6bc6b93ec 100644 --- a/src/pages/docs/golem-js/reference/interfaces/job_job.JobEventsDict.md +++ b/src/pages/docs/golem-js/reference/interfaces/experimental_job_job.JobEventsDict.md @@ -6,18 +6,18 @@ type: "JS API Reference" --- # Interface: JobEventsDict -[job/job](../modules/job_job).JobEventsDict +[experimental/job/job](../modules/experimental_job_job).JobEventsDict ## Table of contents ### Properties -- [created](job_job.JobEventsDict#created) -- [started](job_job.JobEventsDict#started) -- [success](job_job.JobEventsDict#success) -- [error](job_job.JobEventsDict#error) -- [canceled](job_job.JobEventsDict#canceled) -- [ended](job_job.JobEventsDict#ended) +- [created](experimental_job_job.JobEventsDict#created) +- [started](experimental_job_job.JobEventsDict#started) +- [success](experimental_job_job.JobEventsDict#success) +- [error](experimental_job_job.JobEventsDict#error) +- [canceled](experimental_job_job.JobEventsDict#canceled) +- [ended](experimental_job_job.JobEventsDict#ended) ## Properties @@ -31,15 +31,13 @@ Emitted immediately after the job is created and initialization begins. ▸ (): `void` -Emitted immediately after the job is created and initialization begins. - ##### Returns `void` #### Defined in -[src/job/job.ts:31](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L31) +[src/experimental/job/job.ts:42](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L42) ___ @@ -53,15 +51,13 @@ Emitted when the job finishes initialization and work begins. ▸ (): `void` -Emitted when the job finishes initialization and work begins. - ##### Returns `void` #### Defined in -[src/job/job.ts:35](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L35) +[src/experimental/job/job.ts:46](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L46) ___ @@ -75,15 +71,13 @@ Emitted when the job completes successfully and cleanup begins. ▸ (): `void` -Emitted when the job completes successfully and cleanup begins. - ##### Returns `void` #### Defined in -[src/job/job.ts:39](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L39) +[src/experimental/job/job.ts:50](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L50) ___ @@ -97,8 +91,6 @@ Emitted when the job fails and cleanup begins. ▸ (`error`): `void` -Emitted when the job fails and cleanup begins. - ##### Parameters | Name | Type | @@ -111,7 +103,7 @@ Emitted when the job fails and cleanup begins. #### Defined in -[src/job/job.ts:43](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L43) +[src/experimental/job/job.ts:54](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L54) ___ @@ -125,15 +117,13 @@ Emitted when the job is canceled by the user. ▸ (): `void` -Emitted when the job is canceled by the user. - ##### Returns `void` #### Defined in -[src/job/job.ts:47](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L47) +[src/experimental/job/job.ts:58](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L58) ___ @@ -147,12 +137,10 @@ Emitted when the job finishes cleanup after success, error or cancelation. ▸ (): `void` -Emitted when the job finishes cleanup after success, error or cancelation. - ##### Returns `void` #### Defined in -[src/job/job.ts:51](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L51) +[src/experimental/job/job.ts:62](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L62) diff --git a/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.AgreementSelectorOption.md b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.AgreementSelectorOption.md new file mode 100644 index 000000000..3b4e9c25d --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.AgreementSelectorOption.md @@ -0,0 +1,48 @@ +--- +title: "Interface AgreementSelectorOption" +pageTitle: "Interface AgreementSelectorOption - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface AgreementSelectorOption within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: AgreementSelectorOption + +[experimental/reputation/types](../modules/experimental_reputation_types).AgreementSelectorOption + +Options for the agreement selector. + +## Table of contents + +### Properties + +- [topPoolSize](experimental_reputation_types.AgreementSelectorOption#toppoolsize) +- [agreementBonus](experimental_reputation_types.AgreementSelectorOption#agreementbonus) + +## Properties + +### topPoolSize + +• `Optional` **topPoolSize**: `number` + +The size of top provider pool used to pick a random one. + +If you want to just use the best available one, set this to 1. + +Default is `DEFAULT_AGREEMENT_TOP_POOL_SIZE`. + +#### Defined in + +[src/experimental/reputation/types.ts:104](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L104) + +___ + +### agreementBonus + +• `Optional` **agreementBonus**: `number` + +Add extra score to provider if it has an existing agreement. + +Default is 0. + +#### Defined in + +[src/experimental/reputation/types.ts:111](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L111) diff --git a/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ProposalFilterOptions.md b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ProposalFilterOptions.md new file mode 100644 index 000000000..accb5049c --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ProposalFilterOptions.md @@ -0,0 +1,46 @@ +--- +title: "Interface ProposalFilterOptions" +pageTitle: "Interface ProposalFilterOptions - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface ProposalFilterOptions within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: ProposalFilterOptions + +[experimental/reputation/types](../modules/experimental_reputation_types).ProposalFilterOptions + +Options for the proposal filter. + +## Table of contents + +### Properties + +- [acceptUnlisted](experimental_reputation_types.ProposalFilterOptions#acceptunlisted) +- [min](experimental_reputation_types.ProposalFilterOptions#min) + +## Properties + +### acceptUnlisted + +• `Optional` **acceptUnlisted**: `boolean` + +Should providers with no reputation data be accepted. + +Default is false if there are listed providers, true if there are no listed providers. + +#### Defined in + +[src/experimental/reputation/types.ts:82](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L82) + +___ + +### min + +• `Optional` **min**: `number` + +Minimum weighted score a provider on the list needs to have in order to not get rejected. + +Default is `DEFAULT_PROPOSAL_MIN_SCORE`. + +#### Defined in + +[src/experimental/reputation/types.ts:89](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L89) diff --git a/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationConfig.md b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationConfig.md new file mode 100644 index 000000000..0e96929d5 --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationConfig.md @@ -0,0 +1,59 @@ +--- +title: "Interface ReputationConfig" +pageTitle: "Interface ReputationConfig - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface ReputationConfig within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: ReputationConfig + +[experimental/reputation/types](../modules/experimental_reputation_types).ReputationConfig + +Configuration for ReputationSystem class. + +## Table of contents + +### Properties + +- [url](experimental_reputation_types.ReputationConfig#url) +- [paymentNetwork](experimental_reputation_types.ReputationConfig#paymentnetwork) +- [logger](experimental_reputation_types.ReputationConfig#logger) + +## Properties + +### url + +• `Optional` **url**: `string` + +Reputation service URL + +#### Defined in + +[src/experimental/reputation/types.ts:128](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L128) + +___ + +### paymentNetwork + +• `Optional` **paymentNetwork**: `string` + +Network to query data for. + +This is the main filter for the data. + +You can leave it empty if you are controlling the payment network through `PAYMENT_NETWORK` environment variable. + +#### Defined in + +[src/experimental/reputation/types.ts:137](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L137) + +___ + +### logger + +• `Optional` **logger**: [`Logger`](utils_logger_logger.Logger) + +Logger to use. + +#### Defined in + +[src/experimental/reputation/types.ts:142](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L142) diff --git a/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationData.md b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationData.md new file mode 100644 index 000000000..8c9a43c4f --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationData.md @@ -0,0 +1,60 @@ +--- +title: "Interface ReputationData" +pageTitle: "Interface ReputationData - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface ReputationData within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: ReputationData + +[experimental/reputation/types](../modules/experimental_reputation_types).ReputationData + +Reputation data. + +## Table of contents + +### Properties + +- [testedProviders](experimental_reputation_types.ReputationData#testedproviders) +- [rejectedProviders](experimental_reputation_types.ReputationData#rejectedproviders) +- [rejectedOperators](experimental_reputation_types.ReputationData#rejectedoperators) +- [untestedProviders](experimental_reputation_types.ReputationData#untestedproviders) + +## Properties + +### testedProviders + +• **testedProviders**: [`ReputationProviderEntry`](experimental_reputation_types.ReputationProviderEntry)[] + +#### Defined in + +[src/experimental/reputation/types.ts:66](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L66) + +___ + +### rejectedProviders + +• `Optional` **rejectedProviders**: [`ReputationRejectedProvider`](experimental_reputation_types.ReputationRejectedProvider)[] + +#### Defined in + +[src/experimental/reputation/types.ts:67](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L67) + +___ + +### rejectedOperators + +• `Optional` **rejectedOperators**: [`ReputationRejectedOperator`](experimental_reputation_types.ReputationRejectedOperator)[] + +#### Defined in + +[src/experimental/reputation/types.ts:68](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L68) + +___ + +### untestedProviders + +• `Optional` **untestedProviders**: [`ReputationUntestedProvider`](experimental_reputation_types.ReputationUntestedProvider)[] + +#### Defined in + +[src/experimental/reputation/types.ts:69](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L69) diff --git a/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationProviderEntry.md b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationProviderEntry.md new file mode 100644 index 000000000..a363a8b58 --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationProviderEntry.md @@ -0,0 +1,38 @@ +--- +title: "Interface ReputationProviderEntry" +pageTitle: "Interface ReputationProviderEntry - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface ReputationProviderEntry within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: ReputationProviderEntry + +[experimental/reputation/types](../modules/experimental_reputation_types).ReputationProviderEntry + +Reputation provider entry. + +## Table of contents + +### Properties + +- [provider](experimental_reputation_types.ReputationProviderEntry#provider) +- [scores](experimental_reputation_types.ReputationProviderEntry#scores) + +## Properties + +### provider + +• **provider**: [`ProviderInfo`](agreement_agreement.ProviderInfo) + +#### Defined in + +[src/experimental/reputation/types.ts:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L29) + +___ + +### scores + +• **scores**: [`ReputationProviderScores`](experimental_reputation_types.ReputationProviderScores) + +#### Defined in + +[src/experimental/reputation/types.ts:30](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L30) diff --git a/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationProviderScores.md b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationProviderScores.md new file mode 100644 index 000000000..4a600cc53 --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationProviderScores.md @@ -0,0 +1,72 @@ +--- +title: "Interface ReputationProviderScores" +pageTitle: "Interface ReputationProviderScores - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface ReputationProviderScores within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: ReputationProviderScores + +[experimental/reputation/types](../modules/experimental_reputation_types).ReputationProviderScores + +Set of normalized scores for a provider. + +All values are between 0 and 1. + +Higher score is better. + +## Table of contents + +### Properties + +- [successRate](experimental_reputation_types.ReputationProviderScores#successrate) +- [uptime](experimental_reputation_types.ReputationProviderScores#uptime) +- [cpuSingleThreadScore](experimental_reputation_types.ReputationProviderScores#cpusinglethreadscore) +- [cpuMultiThreadScore](experimental_reputation_types.ReputationProviderScores#cpumultithreadscore) + +## Properties + +### successRate + +• **successRate**: `number` + +Percentage of successful tasks in the last "period" (last N test runs?) + +#### Defined in + +[src/experimental/reputation/types.ts:15](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L15) + +___ + +### uptime + +• **uptime**: `number` + +Ping percentage that got responses. + +#### Defined in + +[src/experimental/reputation/types.ts:17](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L17) + +___ + +### cpuSingleThreadScore + +• **cpuSingleThreadScore**: `number` + +CPU single threaded benchmark score. + +#### Defined in + +[src/experimental/reputation/types.ts:19](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L19) + +___ + +### cpuMultiThreadScore + +• **cpuMultiThreadScore**: `number` + +CPU multi-thread benchmark score. + +#### Defined in + +[src/experimental/reputation/types.ts:21](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L21) diff --git a/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationRejectedOperator.md b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationRejectedOperator.md new file mode 100644 index 000000000..109d36d0a --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationRejectedOperator.md @@ -0,0 +1,44 @@ +--- +title: "Interface ReputationRejectedOperator" +pageTitle: "Interface ReputationRejectedOperator - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface ReputationRejectedOperator within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: ReputationRejectedOperator + +[experimental/reputation/types](../modules/experimental_reputation_types).ReputationRejectedOperator + +Information about a rejected operator. + +## Table of contents + +### Properties + +- [operator](experimental_reputation_types.ReputationRejectedOperator#operator) +- [reason](experimental_reputation_types.ReputationRejectedOperator#reason) + +## Properties + +### operator + +• **operator**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `walletAddress` | `string` | + +#### Defined in + +[src/experimental/reputation/types.ts:37](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L37) + +___ + +### reason + +• `Optional` **reason**: `string` + +#### Defined in + +[src/experimental/reputation/types.ts:40](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L40) diff --git a/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationRejectedProvider.md b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationRejectedProvider.md new file mode 100644 index 000000000..62c6012ca --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationRejectedProvider.md @@ -0,0 +1,38 @@ +--- +title: "Interface ReputationRejectedProvider" +pageTitle: "Interface ReputationRejectedProvider - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface ReputationRejectedProvider within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: ReputationRejectedProvider + +[experimental/reputation/types](../modules/experimental_reputation_types).ReputationRejectedProvider + +Information about a rejected provider. + +## Table of contents + +### Properties + +- [provider](experimental_reputation_types.ReputationRejectedProvider#provider) +- [reason](experimental_reputation_types.ReputationRejectedProvider#reason) + +## Properties + +### provider + +• **provider**: [`ProviderInfo`](agreement_agreement.ProviderInfo) + +#### Defined in + +[src/experimental/reputation/types.ts:47](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L47) + +___ + +### reason + +• `Optional` **reason**: `string` + +#### Defined in + +[src/experimental/reputation/types.ts:48](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L48) diff --git a/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationUntestedProvider.md b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationUntestedProvider.md new file mode 100644 index 000000000..f6ecfa175 --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/experimental_reputation_types.ReputationUntestedProvider.md @@ -0,0 +1,44 @@ +--- +title: "Interface ReputationUntestedProvider" +pageTitle: "Interface ReputationUntestedProvider - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface ReputationUntestedProvider within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: ReputationUntestedProvider + +[experimental/reputation/types](../modules/experimental_reputation_types).ReputationUntestedProvider + +Information about untested provider. + +## Table of contents + +### Properties + +- [provider](experimental_reputation_types.ReputationUntestedProvider#provider) +- [scores](experimental_reputation_types.ReputationUntestedProvider#scores) + +## Properties + +### provider + +• **provider**: [`ProviderInfo`](agreement_agreement.ProviderInfo) + +#### Defined in + +[src/experimental/reputation/types.ts:55](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L55) + +___ + +### scores + +• **scores**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `uptime` | `number` | + +#### Defined in + +[src/experimental/reputation/types.ts:56](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L56) diff --git a/src/pages/docs/golem-js/reference/interfaces/market_demand.DemandDetails.md b/src/pages/docs/golem-js/reference/interfaces/market_demand.DemandDetails.md index 80f7580af..6bdf1f2e6 100644 --- a/src/pages/docs/golem-js/reference/interfaces/market_demand.DemandDetails.md +++ b/src/pages/docs/golem-js/reference/interfaces/market_demand.DemandDetails.md @@ -23,7 +23,7 @@ type: "JS API Reference" #### Defined in -[src/market/demand.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L16) +[src/market/demand.ts:21](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L21) ___ @@ -33,4 +33,4 @@ ___ #### Defined in -[src/market/demand.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L17) +[src/market/demand.ts:22](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L22) diff --git a/src/pages/docs/golem-js/reference/interfaces/market_demand.DemandEvents.md b/src/pages/docs/golem-js/reference/interfaces/market_demand.DemandEvents.md new file mode 100644 index 000000000..9da5da1a3 --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/market_demand.DemandEvents.md @@ -0,0 +1,145 @@ +--- +title: "Interface DemandEvents" +pageTitle: "Interface DemandEvents - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface DemandEvents within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: DemandEvents + +[market/demand](../modules/market_demand).DemandEvents + +## Table of contents + +### Properties + +- [proposalReceived](market_demand.DemandEvents#proposalreceived) +- [proposalReceivedError](market_demand.DemandEvents#proposalreceivederror) +- [proposalRejected](market_demand.DemandEvents#proposalrejected) +- [collectFailed](market_demand.DemandEvents#collectfailed) +- [demandUnsubscribed](market_demand.DemandEvents#demandunsubscribed) + +## Properties + +### proposalReceived + +• **proposalReceived**: (`proposal`: [`Proposal`](../classes/market_proposal.Proposal)) => `void` + +#### Type declaration + +▸ (`proposal`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `proposal` | [`Proposal`](../classes/market_proposal.Proposal) | + +##### Returns + +`void` + +#### Defined in + +[src/market/demand.ts:13](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L13) + +___ + +### proposalReceivedError + +• **proposalReceivedError**: (`error`: [`GolemError`](../classes/error_golem_error.GolemError)) => `void` + +#### Type declaration + +▸ (`error`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | [`GolemError`](../classes/error_golem_error.GolemError) | + +##### Returns + +`void` + +#### Defined in + +[src/market/demand.ts:14](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L14) + +___ + +### proposalRejected + +• **proposalRejected**: (`details`: \{ `id`: `string` ; `parentId`: ``null`` \| `string` ; `reason`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.parentId` | ``null`` \| `string` | +| `details.reason` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/market/demand.ts:15](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L15) + +___ + +### collectFailed + +• **collectFailed**: (`details`: \{ `id`: `string` ; `reason`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.reason` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/market/demand.ts:16](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L16) + +___ + +### demandUnsubscribed + +• **demandUnsubscribed**: (`details`: \{ `id`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/market/demand.ts:17](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L17) diff --git a/src/pages/docs/golem-js/reference/interfaces/market_demand.DemandOptions.md b/src/pages/docs/golem-js/reference/interfaces/market_demand.DemandOptions.md index 89c6c24ca..fae17d206 100644 --- a/src/pages/docs/golem-js/reference/interfaces/market_demand.DemandOptions.md +++ b/src/pages/docs/golem-js/reference/interfaces/market_demand.DemandOptions.md @@ -25,7 +25,6 @@ type: "JS API Reference" - [maxOfferEvents](market_demand.DemandOptions#maxofferevents) - [offerFetchingIntervalSec](market_demand.DemandOptions#offerfetchingintervalsec) - [proposalTimeout](market_demand.DemandOptions#proposaltimeout) -- [eventTarget](market_demand.DemandOptions#eventtarget) - [debitNotesAcceptanceTimeoutSec](market_demand.DemandOptions#debitnotesacceptancetimeoutsec) - [midAgreementDebitNoteIntervalSec](market_demand.DemandOptions#midagreementdebitnoteintervalsec) - [midAgreementPaymentTimeoutSec](market_demand.DemandOptions#midagreementpaymenttimeoutsec) @@ -38,17 +37,17 @@ type: "JS API Reference" #### Defined in -[src/market/demand.ts:21](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L21) +[src/market/demand.ts:26](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L26) ___ ### yagnaOptions -• `Optional` **yagnaOptions**: [`YagnaOptions`](../modules/executor_executor#yagnaoptions) +• `Optional` **yagnaOptions**: [`YagnaOptions`](../modules/utils_yagna_yagnaApi#yagnaoptions) #### Defined in -[src/market/demand.ts:22](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L22) +[src/market/demand.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L27) ___ @@ -78,7 +77,7 @@ If your activity is about to operate longer than 10h, you need set both [debitNo #### Defined in -[src/market/demand.ts:45](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L45) +[src/market/demand.ts:50](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L50) ___ @@ -88,7 +87,7 @@ ___ #### Defined in -[src/market/demand.ts:47](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L47) +[src/market/demand.ts:52](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L52) ___ @@ -98,7 +97,7 @@ ___ #### Defined in -[src/market/demand.ts:48](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L48) +[src/market/demand.ts:53](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L53) ___ @@ -108,7 +107,7 @@ ___ #### Defined in -[src/market/demand.ts:50](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L50) +[src/market/demand.ts:55](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L55) ___ @@ -118,17 +117,7 @@ ___ #### Defined in -[src/market/demand.ts:52](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L52) - -___ - -### eventTarget - -• `Optional` **eventTarget**: `EventTarget` - -#### Defined in - -[src/market/demand.ts:54](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L54) +[src/market/demand.ts:57](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L57) ___ @@ -147,7 +136,7 @@ The SDK will accept debit notes each 2 minutes by default. #### Defined in -[src/market/demand.ts:66](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L66) +[src/market/demand.ts:69](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L69) ___ @@ -169,7 +158,7 @@ The SDK will accept debit notes each 2 minutes by default. #### Defined in -[src/market/demand.ts:81](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L81) +[src/market/demand.ts:84](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L84) ___ @@ -189,4 +178,4 @@ The SDK will issue payments each 12h by default, and you can control this with t #### Defined in -[src/market/demand.ts:94](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L94) +[src/market/demand.ts:97](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L97) diff --git a/src/pages/docs/golem-js/reference/interfaces/market_factory.DemandFactoryEvents.md b/src/pages/docs/golem-js/reference/interfaces/market_factory.DemandFactoryEvents.md new file mode 100644 index 000000000..dcbe637ec --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/market_factory.DemandFactoryEvents.md @@ -0,0 +1,67 @@ +--- +title: "Interface DemandFactoryEvents" +pageTitle: "Interface DemandFactoryEvents - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface DemandFactoryEvents within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: DemandFactoryEvents + +[market/factory](../modules/market_factory).DemandFactoryEvents + +## Table of contents + +### Properties + +- [demandSubscribed](market_factory.DemandFactoryEvents#demandsubscribed) +- [demandFailed](market_factory.DemandFactoryEvents#demandfailed) + +## Properties + +### demandSubscribed + +• **demandSubscribed**: (`details`: \{ `id`: `string` ; `details`: [`MarketDecoration`](../modules/market_builder#marketdecoration) }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.details` | [`MarketDecoration`](../modules/market_builder#marketdecoration) | + +##### Returns + +`void` + +#### Defined in + +[src/market/factory.ts:11](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/factory.ts#L11) + +___ + +### demandFailed + +• **demandFailed**: (`details`: \{ `reason`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.reason` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/market/factory.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/factory.ts#L12) diff --git a/src/pages/docs/golem-js/reference/interfaces/market_proposal.ProposalDetails.md b/src/pages/docs/golem-js/reference/interfaces/market_proposal.ProposalDetails.md index 058b25672..3cf1e722e 100644 --- a/src/pages/docs/golem-js/reference/interfaces/market_proposal.ProposalDetails.md +++ b/src/pages/docs/golem-js/reference/interfaces/market_proposal.ProposalDetails.md @@ -32,7 +32,7 @@ type: "JS API Reference" #### Defined in -[src/market/proposal.ts:47](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L47) +[src/market/proposal.ts:53](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L53) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[src/market/proposal.ts:48](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L48) +[src/market/proposal.ts:54](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L54) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[src/market/proposal.ts:49](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L49) +[src/market/proposal.ts:55](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L55) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[src/market/proposal.ts:50](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L50) +[src/market/proposal.ts:56](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L56) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[src/market/proposal.ts:51](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L51) +[src/market/proposal.ts:57](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L57) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[src/market/proposal.ts:52](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L52) +[src/market/proposal.ts:58](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L58) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[src/market/proposal.ts:53](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L53) +[src/market/proposal.ts:59](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L59) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[src/market/proposal.ts:54](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L54) +[src/market/proposal.ts:60](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L60) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[src/market/proposal.ts:55](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L55) +[src/market/proposal.ts:61](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L61) ___ @@ -122,14 +122,14 @@ ___ #### Defined in -[src/market/proposal.ts:56](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L56) +[src/market/proposal.ts:62](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L62) ___ ### state -• **state**: `ProposalAllOfStateEnum` +• **state**: ``"Initial"`` \| ``"Draft"`` \| ``"Rejected"`` \| ``"Accepted"`` \| ``"Expired"`` #### Defined in -[src/market/proposal.ts:57](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L57) +[src/market/proposal.ts:63](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L63) diff --git a/src/pages/docs/golem-js/reference/interfaces/market_proposal.ProposalEvents.md b/src/pages/docs/golem-js/reference/interfaces/market_proposal.ProposalEvents.md new file mode 100644 index 000000000..521e22c28 --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/market_proposal.ProposalEvents.md @@ -0,0 +1,100 @@ +--- +title: "Interface ProposalEvents" +pageTitle: "Interface ProposalEvents - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface ProposalEvents within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: ProposalEvents + +[market/proposal](../modules/market_proposal).ProposalEvents + +## Table of contents + +### Properties + +- [proposalResponded](market_proposal.ProposalEvents#proposalresponded) +- [proposalRejected](market_proposal.ProposalEvents#proposalrejected) +- [proposalFailed](market_proposal.ProposalEvents#proposalfailed) + +## Properties + +### proposalResponded + +• **proposalResponded**: (`details`: \{ `id`: `string` ; `provider`: [`ProviderInfo`](agreement_agreement.ProviderInfo) ; `counteringProposalId`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.provider` | [`ProviderInfo`](agreement_agreement.ProviderInfo) | +| `details.counteringProposalId` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/market/proposal.ts:9](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L9) + +___ + +### proposalRejected + +• **proposalRejected**: (`details`: \{ `id`: `string` ; `provider`: [`ProviderInfo`](agreement_agreement.ProviderInfo) ; `parentId`: ``null`` \| `string` ; `reason`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.provider` | [`ProviderInfo`](agreement_agreement.ProviderInfo) | +| `details.parentId` | ``null`` \| `string` | +| `details.reason` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/market/proposal.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L10) + +___ + +### proposalFailed + +• **proposalFailed**: (`details`: \{ `id`: `string` ; `provider`: [`ProviderInfo`](agreement_agreement.ProviderInfo) ; `parentId`: ``null`` \| `string` ; `reason`: `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.provider` | [`ProviderInfo`](agreement_agreement.ProviderInfo) | +| `details.parentId` | ``null`` \| `string` | +| `details.reason` | `string` | + +##### Returns + +`void` + +#### Defined in + +[src/market/proposal.ts:11](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L11) diff --git a/src/pages/docs/golem-js/reference/interfaces/market_service.MarketOptions.md b/src/pages/docs/golem-js/reference/interfaces/market_service.MarketOptions.md index f70ea1e96..df49f3bd0 100644 --- a/src/pages/docs/golem-js/reference/interfaces/market_service.MarketOptions.md +++ b/src/pages/docs/golem-js/reference/interfaces/market_service.MarketOptions.md @@ -28,7 +28,6 @@ type: "JS API Reference" - [maxOfferEvents](market_service.MarketOptions#maxofferevents) - [offerFetchingIntervalSec](market_service.MarketOptions#offerfetchingintervalsec) - [proposalTimeout](market_service.MarketOptions#proposaltimeout) -- [eventTarget](market_service.MarketOptions#eventtarget) - [debitNotesAcceptanceTimeoutSec](market_service.MarketOptions#debitnotesacceptancetimeoutsec) - [midAgreementDebitNoteIntervalSec](market_service.MarketOptions#midagreementdebitnoteintervalsec) - [midAgreementPaymentTimeoutSec](market_service.MarketOptions#midagreementpaymenttimeoutsec) @@ -44,7 +43,7 @@ Duplicate proposals from one provider are reduced to the cheapest one. #### Defined in -[src/market/service.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/service.ts#L18) +[src/market/service.ts:19](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/service.ts#L19) ___ @@ -56,7 +55,7 @@ The minimum number of proposals after which the batch of proposal will be proces #### Defined in -[src/market/service.ts:20](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/service.ts#L20) +[src/market/service.ts:21](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/service.ts#L21) ___ @@ -68,7 +67,7 @@ The maximum waiting time for proposals to be batched in order to avoid duplicate #### Defined in -[src/market/service.ts:22](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/service.ts#L22) +[src/market/service.ts:23](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/service.ts#L23) ___ @@ -82,13 +81,13 @@ ___ #### Defined in -[src/market/demand.ts:21](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L21) +[src/market/demand.ts:26](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L26) ___ ### yagnaOptions -• `Optional` **yagnaOptions**: [`YagnaOptions`](../modules/executor_executor#yagnaoptions) +• `Optional` **yagnaOptions**: [`YagnaOptions`](../modules/utils_yagna_yagnaApi#yagnaoptions) #### Inherited from @@ -96,7 +95,7 @@ ___ #### Defined in -[src/market/demand.ts:22](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L22) +[src/market/demand.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L27) ___ @@ -130,7 +129,7 @@ If your activity is about to operate longer than 10h, you need set both [debitNo #### Defined in -[src/market/demand.ts:45](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L45) +[src/market/demand.ts:50](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L50) ___ @@ -144,7 +143,7 @@ ___ #### Defined in -[src/market/demand.ts:47](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L47) +[src/market/demand.ts:52](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L52) ___ @@ -158,7 +157,7 @@ ___ #### Defined in -[src/market/demand.ts:48](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L48) +[src/market/demand.ts:53](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L53) ___ @@ -172,7 +171,7 @@ ___ #### Defined in -[src/market/demand.ts:50](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L50) +[src/market/demand.ts:55](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L55) ___ @@ -186,21 +185,7 @@ ___ #### Defined in -[src/market/demand.ts:52](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L52) - -___ - -### eventTarget - -• `Optional` **eventTarget**: `EventTarget` - -#### Inherited from - -[DemandOptions](market_demand.DemandOptions).[eventTarget](market_demand.DemandOptions#eventtarget) - -#### Defined in - -[src/market/demand.ts:54](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L54) +[src/market/demand.ts:57](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L57) ___ @@ -223,7 +208,7 @@ The SDK will accept debit notes each 2 minutes by default. #### Defined in -[src/market/demand.ts:66](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L66) +[src/market/demand.ts:69](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L69) ___ @@ -249,7 +234,7 @@ The SDK will accept debit notes each 2 minutes by default. #### Defined in -[src/market/demand.ts:81](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L81) +[src/market/demand.ts:84](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L84) ___ @@ -273,4 +258,4 @@ The SDK will issue payments each 12h by default, and you can control this with t #### Defined in -[src/market/demand.ts:94](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/demand.ts#L94) +[src/market/demand.ts:97](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/demand.ts#L97) diff --git a/src/pages/docs/golem-js/reference/interfaces/network_network.NetworkInfo.md b/src/pages/docs/golem-js/reference/interfaces/network_network.NetworkInfo.md index 1aaaa42c5..590c12646 100644 --- a/src/pages/docs/golem-js/reference/interfaces/network_network.NetworkInfo.md +++ b/src/pages/docs/golem-js/reference/interfaces/network_network.NetworkInfo.md @@ -25,7 +25,7 @@ type: "JS API Reference" #### Defined in -[src/network/network.ts:29](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/network.ts#L29) +[src/network/network.ts:28](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/network.ts#L28) ___ @@ -35,7 +35,7 @@ ___ #### Defined in -[src/network/network.ts:30](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/network.ts#L30) +[src/network/network.ts:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/network.ts#L29) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[src/network/network.ts:31](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/network.ts#L31) +[src/network/network.ts:30](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/network.ts#L30) ___ @@ -59,4 +59,4 @@ ___ #### Defined in -[src/network/network.ts:32](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/network.ts#L32) +[src/network/network.ts:31](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/network.ts#L31) diff --git a/src/pages/docs/golem-js/reference/interfaces/package_package.PackageDetails.md b/src/pages/docs/golem-js/reference/interfaces/package_package.PackageDetails.md index b8f009756..050dcb02d 100644 --- a/src/pages/docs/golem-js/reference/interfaces/package_package.PackageDetails.md +++ b/src/pages/docs/golem-js/reference/interfaces/package_package.PackageDetails.md @@ -28,7 +28,7 @@ type: "JS API Reference" #### Defined in -[src/package/package.ts:37](https://github.com/golemfactory/golem-js/blob/7cee55b/src/package/package.ts#L37) +[src/package/package.ts:43](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/package/package.ts#L43) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[src/package/package.ts:38](https://github.com/golemfactory/golem-js/blob/7cee55b/src/package/package.ts#L38) +[src/package/package.ts:44](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/package/package.ts#L44) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[src/package/package.ts:39](https://github.com/golemfactory/golem-js/blob/7cee55b/src/package/package.ts#L39) +[src/package/package.ts:45](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/package/package.ts#L45) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[src/package/package.ts:40](https://github.com/golemfactory/golem-js/blob/7cee55b/src/package/package.ts#L40) +[src/package/package.ts:46](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/package/package.ts#L46) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[src/package/package.ts:41](https://github.com/golemfactory/golem-js/blob/7cee55b/src/package/package.ts#L41) +[src/package/package.ts:47](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/package/package.ts#L47) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[src/package/package.ts:42](https://github.com/golemfactory/golem-js/blob/7cee55b/src/package/package.ts#L42) +[src/package/package.ts:48](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/package/package.ts#L48) ___ @@ -88,4 +88,4 @@ ___ #### Defined in -[src/package/package.ts:43](https://github.com/golemfactory/golem-js/blob/7cee55b/src/package/package.ts#L43) +[src/package/package.ts:49](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/package/package.ts#L49) diff --git a/src/pages/docs/golem-js/reference/interfaces/payment_config.BasePaymentOptions.md b/src/pages/docs/golem-js/reference/interfaces/payment_config.BasePaymentOptions.md index 9e5e02578..9432fcced 100644 --- a/src/pages/docs/golem-js/reference/interfaces/payment_config.BasePaymentOptions.md +++ b/src/pages/docs/golem-js/reference/interfaces/payment_config.BasePaymentOptions.md @@ -27,17 +27,16 @@ type: "JS API Reference" - [paymentRequestTimeout](payment_config.BasePaymentOptions#paymentrequesttimeout) - [unsubscribeTimeoutMs](payment_config.BasePaymentOptions#unsubscribetimeoutms) - [logger](payment_config.BasePaymentOptions#logger) -- [eventTarget](payment_config.BasePaymentOptions#eventtarget) ## Properties ### yagnaOptions -• `Optional` **yagnaOptions**: [`YagnaOptions`](../modules/executor_executor#yagnaoptions) +• `Optional` **yagnaOptions**: [`YagnaOptions`](../modules/utils_yagna_yagnaApi#yagnaoptions) #### Defined in -[src/payment/config.ts:25](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L25) +[src/payment/config.ts:24](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L24) ___ @@ -47,7 +46,7 @@ ___ #### Defined in -[src/payment/config.ts:26](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L26) +[src/payment/config.ts:25](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L25) ___ @@ -64,7 +63,7 @@ ___ #### Defined in -[src/payment/config.ts:27](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L27) +[src/payment/config.ts:26](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L26) ___ @@ -74,7 +73,7 @@ ___ #### Defined in -[src/payment/config.ts:28](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L28) +[src/payment/config.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L27) ___ @@ -84,7 +83,7 @@ ___ #### Defined in -[src/payment/config.ts:29](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L29) +[src/payment/config.ts:28](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L28) ___ @@ -94,7 +93,7 @@ ___ #### Defined in -[src/payment/config.ts:30](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L30) +[src/payment/config.ts:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L29) ___ @@ -104,14 +103,4 @@ ___ #### Defined in -[src/payment/config.ts:31](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L31) - -___ - -### eventTarget - -• `Optional` **eventTarget**: `EventTarget` - -#### Defined in - -[src/payment/config.ts:32](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L32) +[src/payment/config.ts:30](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L30) diff --git a/src/pages/docs/golem-js/reference/interfaces/payment_debit_note.DebitNoteDTO.md b/src/pages/docs/golem-js/reference/interfaces/payment_debit_note.DebitNoteDTO.md index 0cee8dfdd..976c94180 100644 --- a/src/pages/docs/golem-js/reference/interfaces/payment_debit_note.DebitNoteDTO.md +++ b/src/pages/docs/golem-js/reference/interfaces/payment_debit_note.DebitNoteDTO.md @@ -27,7 +27,7 @@ type: "JS API Reference" #### Defined in -[src/payment/debit_note.ts:14](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/debit_note.ts#L14) +[src/payment/debit_note.ts:19](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/debit_note.ts#L19) ___ @@ -37,7 +37,7 @@ ___ #### Defined in -[src/payment/debit_note.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/debit_note.ts#L15) +[src/payment/debit_note.ts:20](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/debit_note.ts#L20) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[src/payment/debit_note.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/debit_note.ts#L16) +[src/payment/debit_note.ts:21](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/debit_note.ts#L21) ___ @@ -57,17 +57,17 @@ ___ #### Defined in -[src/payment/debit_note.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/debit_note.ts#L17) +[src/payment/debit_note.ts:22](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/debit_note.ts#L22) ___ ### totalAmountDue -• **totalAmountDue**: `number` +• **totalAmountDue**: `string` #### Defined in -[src/payment/debit_note.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/debit_note.ts#L18) +[src/payment/debit_note.ts:23](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/debit_note.ts#L23) ___ @@ -77,4 +77,4 @@ ___ #### Defined in -[src/payment/debit_note.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/debit_note.ts#L19) +[src/payment/debit_note.ts:24](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/debit_note.ts#L24) diff --git a/src/pages/docs/golem-js/reference/interfaces/payment_debit_note.DebitNoteEvents.md b/src/pages/docs/golem-js/reference/interfaces/payment_debit_note.DebitNoteEvents.md new file mode 100644 index 000000000..e19455b70 --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/payment_debit_note.DebitNoteEvents.md @@ -0,0 +1,71 @@ +--- +title: "Interface DebitNoteEvents" +pageTitle: "Interface DebitNoteEvents - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface DebitNoteEvents within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: DebitNoteEvents + +[payment/debit\_note](../modules/payment_debit_note).DebitNoteEvents + +## Table of contents + +### Properties + +- [accepted](payment_debit_note.DebitNoteEvents#accepted) +- [paymentFailed](payment_debit_note.DebitNoteEvents#paymentfailed) + +## Properties + +### accepted + +• **accepted**: (`details`: \{ `id`: `string` ; `agreementId`: `string` ; `amount`: `string` ; `provider`: [`ProviderInfo`](agreement_agreement.ProviderInfo) }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.agreementId` | `string` | +| `details.amount` | `string` | +| `details.provider` | [`ProviderInfo`](agreement_agreement.ProviderInfo) | + +##### Returns + +`void` + +#### Defined in + +[src/payment/debit_note.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/debit_note.ts#L12) + +___ + +### paymentFailed + +• **paymentFailed**: (`details`: \{ `id`: `string` ; `agreementId`: `string` ; `reason`: `undefined` \| `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.agreementId` | `string` | +| `details.reason` | `undefined` \| `string` | + +##### Returns + +`void` + +#### Defined in + +[src/payment/debit_note.ts:13](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/debit_note.ts#L13) diff --git a/src/pages/docs/golem-js/reference/interfaces/payment_invoice.InvoiceDTO.md b/src/pages/docs/golem-js/reference/interfaces/payment_invoice.InvoiceDTO.md index 9515063b9..a43165901 100644 --- a/src/pages/docs/golem-js/reference/interfaces/payment_invoice.InvoiceDTO.md +++ b/src/pages/docs/golem-js/reference/interfaces/payment_invoice.InvoiceDTO.md @@ -31,7 +31,7 @@ type: "JS API Reference" #### Defined in -[src/payment/invoice.ts:13](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/invoice.ts#L13) +[src/payment/invoice.ts:18](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/invoice.ts#L18) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[src/payment/invoice.ts:14](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/invoice.ts#L14) +[src/payment/invoice.ts:19](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/invoice.ts#L19) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[src/payment/invoice.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/invoice.ts#L15) +[src/payment/invoice.ts:20](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/invoice.ts#L20) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[src/payment/invoice.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/invoice.ts#L16) +[src/payment/invoice.ts:21](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/invoice.ts#L21) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[src/payment/invoice.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/invoice.ts#L17) +[src/payment/invoice.ts:22](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/invoice.ts#L22) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[src/payment/invoice.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/invoice.ts#L18) +[src/payment/invoice.ts:23](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/invoice.ts#L23) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[src/payment/invoice.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/invoice.ts#L19) +[src/payment/invoice.ts:24](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/invoice.ts#L24) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -[src/payment/invoice.ts:20](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/invoice.ts#L20) +[src/payment/invoice.ts:25](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/invoice.ts#L25) ___ @@ -111,14 +111,14 @@ ___ #### Defined in -[src/payment/invoice.ts:21](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/invoice.ts#L21) +[src/payment/invoice.ts:26](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/invoice.ts#L26) ___ ### amount -• **amount**: `number` +• **amount**: `string` #### Defined in -[src/payment/invoice.ts:22](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/invoice.ts#L22) +[src/payment/invoice.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/invoice.ts#L27) diff --git a/src/pages/docs/golem-js/reference/interfaces/payment_invoice.InvoiceEvents.md b/src/pages/docs/golem-js/reference/interfaces/payment_invoice.InvoiceEvents.md new file mode 100644 index 000000000..35099c980 --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/payment_invoice.InvoiceEvents.md @@ -0,0 +1,71 @@ +--- +title: "Interface InvoiceEvents" +pageTitle: "Interface InvoiceEvents - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface InvoiceEvents within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: InvoiceEvents + +[payment/invoice](../modules/payment_invoice).InvoiceEvents + +## Table of contents + +### Properties + +- [accepted](payment_invoice.InvoiceEvents#accepted) +- [paymentFailed](payment_invoice.InvoiceEvents#paymentfailed) + +## Properties + +### accepted + +• **accepted**: (`details`: \{ `id`: `string` ; `agreementId`: `string` ; `amount`: `string` ; `provider`: [`ProviderInfo`](agreement_agreement.ProviderInfo) }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.agreementId` | `string` | +| `details.amount` | `string` | +| `details.provider` | [`ProviderInfo`](agreement_agreement.ProviderInfo) | + +##### Returns + +`void` + +#### Defined in + +[src/payment/invoice.ts:11](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/invoice.ts#L11) + +___ + +### paymentFailed + +• **paymentFailed**: (`details`: \{ `id`: `string` ; `agreementId`: `string` ; `reason`: `undefined` \| `string` }) => `void` + +#### Type declaration + +▸ (`details`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `details` | `Object` | +| `details.id` | `string` | +| `details.agreementId` | `string` | +| `details.reason` | `undefined` \| `string` | + +##### Returns + +`void` + +#### Defined in + +[src/payment/invoice.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/invoice.ts#L12) diff --git a/src/pages/docs/golem-js/reference/interfaces/payment_payments.PaymentEvents.md b/src/pages/docs/golem-js/reference/interfaces/payment_payments.PaymentEvents.md new file mode 100644 index 000000000..0fdc5ca37 --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/payment_payments.PaymentEvents.md @@ -0,0 +1,83 @@ +--- +title: "Interface PaymentEvents" +pageTitle: "Interface PaymentEvents - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface PaymentEvents within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: PaymentEvents + +[payment/payments](../modules/payment_payments).PaymentEvents + +## Table of contents + +### Properties + +- [invoiceReceived](payment_payments.PaymentEvents#invoicereceived) +- [debitNoteReceived](payment_payments.PaymentEvents#debitnotereceived) +- [unsubscribed](payment_payments.PaymentEvents#unsubscribed) + +## Properties + +### invoiceReceived + +• **invoiceReceived**: (`invoice`: `Invoice`) => `void` + +#### Type declaration + +▸ (`invoice`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `invoice` | `Invoice` | + +##### Returns + +`void` + +#### Defined in + +[src/payment/payments.ts:9](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/payments.ts#L9) + +___ + +### debitNoteReceived + +• **debitNoteReceived**: (`debitNote`: `DebitNote`) => `void` + +#### Type declaration + +▸ (`debitNote`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `debitNote` | `DebitNote` | + +##### Returns + +`void` + +#### Defined in + +[src/payment/payments.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/payments.ts#L10) + +___ + +### unsubscribed + +• **unsubscribed**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +#### Defined in + +[src/payment/payments.ts:11](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/payments.ts#L11) diff --git a/src/pages/docs/golem-js/reference/interfaces/payment_payments.PaymentOptions.md b/src/pages/docs/golem-js/reference/interfaces/payment_payments.PaymentOptions.md index 8c9974a14..e9fd1cc95 100644 --- a/src/pages/docs/golem-js/reference/interfaces/payment_payments.PaymentOptions.md +++ b/src/pages/docs/golem-js/reference/interfaces/payment_payments.PaymentOptions.md @@ -29,7 +29,6 @@ type: "JS API Reference" - [paymentRequestTimeout](payment_payments.PaymentOptions#paymentrequesttimeout) - [unsubscribeTimeoutMs](payment_payments.PaymentOptions#unsubscribetimeoutms) - [logger](payment_payments.PaymentOptions#logger) -- [eventTarget](payment_payments.PaymentOptions#eventtarget) ## Properties @@ -39,7 +38,7 @@ type: "JS API Reference" #### Defined in -[src/payment/payments.ts:9](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/payments.ts#L9) +[src/payment/payments.ts:15](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/payments.ts#L15) ___ @@ -49,7 +48,7 @@ ___ #### Defined in -[src/payment/payments.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/payments.ts#L10) +[src/payment/payments.ts:16](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/payments.ts#L16) ___ @@ -59,7 +58,7 @@ ___ #### Defined in -[src/payment/payments.ts:11](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/payments.ts#L11) +[src/payment/payments.ts:17](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/payments.ts#L17) ___ @@ -69,13 +68,13 @@ ___ #### Defined in -[src/payment/payments.ts:12](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/payments.ts#L12) +[src/payment/payments.ts:18](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/payments.ts#L18) ___ ### yagnaOptions -• `Optional` **yagnaOptions**: [`YagnaOptions`](../modules/executor_executor#yagnaoptions) +• `Optional` **yagnaOptions**: [`YagnaOptions`](../modules/utils_yagna_yagnaApi#yagnaoptions) #### Inherited from @@ -83,7 +82,7 @@ ___ #### Defined in -[src/payment/config.ts:25](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L25) +[src/payment/config.ts:24](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L24) ___ @@ -97,7 +96,7 @@ ___ #### Defined in -[src/payment/config.ts:26](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L26) +[src/payment/config.ts:25](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L25) ___ @@ -118,7 +117,7 @@ ___ #### Defined in -[src/payment/config.ts:27](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L27) +[src/payment/config.ts:26](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L26) ___ @@ -132,7 +131,7 @@ ___ #### Defined in -[src/payment/config.ts:28](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L28) +[src/payment/config.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L27) ___ @@ -146,7 +145,7 @@ ___ #### Defined in -[src/payment/config.ts:29](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L29) +[src/payment/config.ts:28](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L28) ___ @@ -160,7 +159,7 @@ ___ #### Defined in -[src/payment/config.ts:30](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L30) +[src/payment/config.ts:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L29) ___ @@ -174,18 +173,4 @@ ___ #### Defined in -[src/payment/config.ts:31](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L31) - -___ - -### eventTarget - -• `Optional` **eventTarget**: `EventTarget` - -#### Inherited from - -[BasePaymentOptions](payment_config.BasePaymentOptions).[eventTarget](payment_config.BasePaymentOptions#eventtarget) - -#### Defined in - -[src/payment/config.ts:32](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L32) +[src/payment/config.ts:30](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L30) diff --git a/src/pages/docs/golem-js/reference/interfaces/payment_service.PaymentOptions.md b/src/pages/docs/golem-js/reference/interfaces/payment_service.PaymentOptions.md index e02d3557b..4c545d7e3 100644 --- a/src/pages/docs/golem-js/reference/interfaces/payment_service.PaymentOptions.md +++ b/src/pages/docs/golem-js/reference/interfaces/payment_service.PaymentOptions.md @@ -31,7 +31,6 @@ type: "JS API Reference" - [paymentRequestTimeout](payment_service.PaymentOptions#paymentrequesttimeout) - [unsubscribeTimeoutMs](payment_service.PaymentOptions#unsubscribetimeoutms) - [logger](payment_service.PaymentOptions#logger) -- [eventTarget](payment_service.PaymentOptions#eventtarget) ## Properties @@ -43,7 +42,7 @@ Interval for checking new invoices #### Defined in -[src/payment/service.ts:24](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/service.ts#L24) +[src/payment/service.ts:25](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/service.ts#L25) ___ @@ -55,7 +54,7 @@ Interval for checking new debit notes #### Defined in -[src/payment/service.ts:26](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/service.ts#L26) +[src/payment/service.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/service.ts#L27) ___ @@ -67,7 +66,7 @@ Maximum number of invoice events per one fetching #### Defined in -[src/payment/service.ts:28](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/service.ts#L28) +[src/payment/service.ts:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/service.ts#L29) ___ @@ -79,7 +78,7 @@ Maximum number of debit notes events per one fetching #### Defined in -[src/payment/service.ts:30](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/service.ts#L30) +[src/payment/service.ts:31](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/service.ts#L31) ___ @@ -91,7 +90,7 @@ A custom filter that checks every debit notes coming from providers #### Defined in -[src/payment/service.ts:32](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/service.ts#L32) +[src/payment/service.ts:33](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/service.ts#L33) ___ @@ -103,13 +102,13 @@ A custom filter that checks every invoices coming from providers #### Defined in -[src/payment/service.ts:34](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/service.ts#L34) +[src/payment/service.ts:35](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/service.ts#L35) ___ ### yagnaOptions -• `Optional` **yagnaOptions**: [`YagnaOptions`](../modules/executor_executor#yagnaoptions) +• `Optional` **yagnaOptions**: [`YagnaOptions`](../modules/utils_yagna_yagnaApi#yagnaoptions) #### Inherited from @@ -117,7 +116,7 @@ ___ #### Defined in -[src/payment/config.ts:25](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L25) +[src/payment/config.ts:24](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L24) ___ @@ -131,7 +130,7 @@ ___ #### Defined in -[src/payment/config.ts:26](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L26) +[src/payment/config.ts:25](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L25) ___ @@ -152,7 +151,7 @@ ___ #### Defined in -[src/payment/config.ts:27](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L27) +[src/payment/config.ts:26](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L26) ___ @@ -166,7 +165,7 @@ ___ #### Defined in -[src/payment/config.ts:28](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L28) +[src/payment/config.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L27) ___ @@ -180,7 +179,7 @@ ___ #### Defined in -[src/payment/config.ts:29](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L29) +[src/payment/config.ts:28](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L28) ___ @@ -194,7 +193,7 @@ ___ #### Defined in -[src/payment/config.ts:30](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L30) +[src/payment/config.ts:29](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L29) ___ @@ -208,18 +207,4 @@ ___ #### Defined in -[src/payment/config.ts:31](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L31) - -___ - -### eventTarget - -• `Optional` **eventTarget**: `EventTarget` - -#### Inherited from - -[BasePaymentOptions](payment_config.BasePaymentOptions).[eventTarget](payment_config.BasePaymentOptions#eventtarget) - -#### Defined in - -[src/payment/config.ts:32](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/config.ts#L32) +[src/payment/config.ts:30](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/config.ts#L30) diff --git a/src/pages/docs/golem-js/reference/interfaces/payment_service.PaymentServiceEvents.md b/src/pages/docs/golem-js/reference/interfaces/payment_service.PaymentServiceEvents.md new file mode 100644 index 000000000..fc16deffd --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/payment_service.PaymentServiceEvents.md @@ -0,0 +1,67 @@ +--- +title: "Interface PaymentServiceEvents" +pageTitle: "Interface PaymentServiceEvents - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface PaymentServiceEvents within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: PaymentServiceEvents + +[payment/service](../modules/payment_service).PaymentServiceEvents + +## Table of contents + +### Properties + +- [error](payment_service.PaymentServiceEvents#error) +- [allocationCreated](payment_service.PaymentServiceEvents#allocationcreated) + +## Properties + +### error + +• **error**: (`err`: `Error`) => `void` + +Triggered when the service encounters an issue in an "asynchronous sub-process" (like accepting payments) +that should be notified to the caller + +#### Type declaration + +▸ (`err`): `void` + +##### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `err` | `Error` | The error raised during an asynchronous process executed by the PaymentService | + +##### Returns + +`void` + +#### Defined in + +[src/payment/service.ts:19](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/service.ts#L19) + +___ + +### allocationCreated + +• **allocationCreated**: (`allocation`: `Allocation`) => `void` + +#### Type declaration + +▸ (`allocation`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `allocation` | `Allocation` | + +##### Returns + +`void` + +#### Defined in + +[src/payment/service.ts:20](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/service.ts#L20) diff --git a/src/pages/docs/golem-js/reference/interfaces/storage_provider.StorageProvider.md b/src/pages/docs/golem-js/reference/interfaces/storage_provider.StorageProvider.md index 0dc0a8b2b..cc92d4022 100644 --- a/src/pages/docs/golem-js/reference/interfaces/storage_provider.StorageProvider.md +++ b/src/pages/docs/golem-js/reference/interfaces/storage_provider.StorageProvider.md @@ -40,7 +40,7 @@ Initialize storage provider. #### Defined in -[src/storage/provider.ts:7](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/provider.ts#L7) +[src/storage/provider.ts:7](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/provider.ts#L7) ___ @@ -56,7 +56,7 @@ Close storage provider and release all resources. #### Defined in -[src/storage/provider.ts:12](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/provider.ts#L12) +[src/storage/provider.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/provider.ts#L12) ___ @@ -78,7 +78,7 @@ Return allocated resource URL from Yagna of a file to be downloaded. #### Defined in -[src/storage/provider.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/provider.ts#L17) +[src/storage/provider.ts:17](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/provider.ts#L17) ___ @@ -100,7 +100,7 @@ Return allocated resource URL from Yagna of a file to be downloaded. #### Defined in -[src/storage/provider.ts:22](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/provider.ts#L22) +[src/storage/provider.ts:22](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/provider.ts#L22) ___ @@ -122,7 +122,7 @@ Return allocated resource URL from Yagna of a file to be uploaded. #### Defined in -[src/storage/provider.ts:28](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/provider.ts#L28) +[src/storage/provider.ts:28](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/provider.ts#L28) ___ @@ -144,7 +144,7 @@ Return allocated resource URL from Yagna of data to be uploaded. #### Defined in -[src/storage/provider.ts:34](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/provider.ts#L34) +[src/storage/provider.ts:34](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/provider.ts#L34) ___ @@ -166,4 +166,4 @@ Release previously allocated resource URL from Yagna. #### Defined in -[src/storage/provider.ts:40](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/provider.ts#L40) +[src/storage/provider.ts:40](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/provider.ts#L40) diff --git a/src/pages/docs/golem-js/reference/interfaces/storage_ws_browser.WebSocketStorageProviderOptions.md b/src/pages/docs/golem-js/reference/interfaces/storage_ws_browser.WebSocketStorageProviderOptions.md index a3a61c255..3089a1d25 100644 --- a/src/pages/docs/golem-js/reference/interfaces/storage_ws_browser.WebSocketStorageProviderOptions.md +++ b/src/pages/docs/golem-js/reference/interfaces/storage_ws_browser.WebSocketStorageProviderOptions.md @@ -22,4 +22,4 @@ type: "JS API Reference" #### Defined in -[src/storage/ws-browser.ts:9](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/ws-browser.ts#L9) +[src/storage/ws-browser.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/ws-browser.ts#L10) diff --git a/src/pages/docs/golem-js/reference/interfaces/task_service.TaskServiceOptions.md b/src/pages/docs/golem-js/reference/interfaces/task_service.TaskServiceOptions.md deleted file mode 100644 index 5c6f6f597..000000000 --- a/src/pages/docs/golem-js/reference/interfaces/task_service.TaskServiceOptions.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -title: "Interface TaskServiceOptions" -pageTitle: "Interface TaskServiceOptions - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Interface TaskServiceOptions within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Interface: TaskServiceOptions - -[task/service](../modules/task_service).TaskServiceOptions - -## Hierarchy - -- [`ActivityOptions`](activity_activity.ActivityOptions) - - ↳ **`TaskServiceOptions`** - -## Table of contents - -### Properties - -- [maxParallelTasks](task_service.TaskServiceOptions#maxparalleltasks) -- [taskRunningInterval](task_service.TaskServiceOptions#taskrunninginterval) -- [activityStateCheckingInterval](task_service.TaskServiceOptions#activitystatecheckinginterval) -- [activityPreparingTimeout](task_service.TaskServiceOptions#activitypreparingtimeout) -- [taskTimeout](task_service.TaskServiceOptions#tasktimeout) -- [logger](task_service.TaskServiceOptions#logger) -- [storageProvider](task_service.TaskServiceOptions#storageprovider) -- [activityRequestTimeout](task_service.TaskServiceOptions#activityrequesttimeout) -- [activityExecuteTimeout](task_service.TaskServiceOptions#activityexecutetimeout) -- [activityExeBatchResultPollIntervalSeconds](task_service.TaskServiceOptions#activityexebatchresultpollintervalseconds) -- [eventTarget](task_service.TaskServiceOptions#eventtarget) - -## Properties - -### maxParallelTasks - -• `Optional` **maxParallelTasks**: `number` - -Number of maximum parallel running task on one TaskExecutor instance - -#### Defined in - -[src/task/service.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/service.ts#L15) - -___ - -### taskRunningInterval - -• `Optional` **taskRunningInterval**: `number` - -#### Defined in - -[src/task/service.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/service.ts#L16) - -___ - -### activityStateCheckingInterval - -• `Optional` **activityStateCheckingInterval**: `number` - -#### Defined in - -[src/task/service.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/service.ts#L17) - -___ - -### activityPreparingTimeout - -• `Optional` **activityPreparingTimeout**: `number` - -#### Defined in - -[src/task/service.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/service.ts#L18) - -___ - -### taskTimeout - -• `Optional` **taskTimeout**: `number` - -#### Defined in - -[src/task/service.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/service.ts#L19) - -___ - -### logger - -• `Optional` **logger**: [`Logger`](utils_logger_logger.Logger) - -Logger module - -#### Overrides - -[ActivityOptions](activity_activity.ActivityOptions).[logger](activity_activity.ActivityOptions#logger) - -#### Defined in - -[src/task/service.ts:20](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/service.ts#L20) - -___ - -### storageProvider - -• `Optional` **storageProvider**: [`StorageProvider`](storage_provider.StorageProvider) - -#### Defined in - -[src/task/service.ts:21](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/service.ts#L21) - -___ - -### activityRequestTimeout - -• `Optional` **activityRequestTimeout**: `number` - -timeout for sending and creating batch - -#### Inherited from - -[ActivityOptions](activity_activity.ActivityOptions).[activityRequestTimeout](activity_activity.ActivityOptions#activityrequesttimeout) - -#### Defined in - -[src/activity/activity.ts:28](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L28) - -___ - -### activityExecuteTimeout - -• `Optional` **activityExecuteTimeout**: `number` - -timeout for executing batch - -#### Inherited from - -[ActivityOptions](activity_activity.ActivityOptions).[activityExecuteTimeout](activity_activity.ActivityOptions#activityexecutetimeout) - -#### Defined in - -[src/activity/activity.ts:30](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L30) - -___ - -### activityExeBatchResultPollIntervalSeconds - -• `Optional` **activityExeBatchResultPollIntervalSeconds**: `number` - -interval for fetching batch results while polling - -#### Inherited from - -[ActivityOptions](activity_activity.ActivityOptions).[activityExeBatchResultPollIntervalSeconds](activity_activity.ActivityOptions#activityexebatchresultpollintervalseconds) - -#### Defined in - -[src/activity/activity.ts:32](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L32) - -___ - -### eventTarget - -• `Optional` **eventTarget**: `EventTarget` - -Event Bus implements EventTarget - -#### Inherited from - -[ActivityOptions](activity_activity.ActivityOptions).[eventTarget](activity_activity.ActivityOptions#eventtarget) - -#### Defined in - -[src/activity/activity.ts:36](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L36) diff --git a/src/pages/docs/golem-js/reference/interfaces/task_work.WorkOptions.md b/src/pages/docs/golem-js/reference/interfaces/task_work.WorkOptions.md deleted file mode 100644 index 2a09a2835..000000000 --- a/src/pages/docs/golem-js/reference/interfaces/task_work.WorkOptions.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "Interface WorkOptions" -pageTitle: "Interface WorkOptions - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Interface WorkOptions within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Interface: WorkOptions - -[task/work](../modules/task_work).WorkOptions - -## Table of contents - -### Properties - -- [activityPreparingTimeout](task_work.WorkOptions#activitypreparingtimeout) -- [activityStateCheckingInterval](task_work.WorkOptions#activitystatecheckinginterval) -- [storageProvider](task_work.WorkOptions#storageprovider) -- [networkNode](task_work.WorkOptions#networknode) -- [logger](task_work.WorkOptions#logger) -- [activityReadySetupFunctions](task_work.WorkOptions#activityreadysetupfunctions) - -## Properties - -### activityPreparingTimeout - -• `Optional` **activityPreparingTimeout**: `number` - -#### Defined in - -[src/task/work.ts:32](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L32) - -___ - -### activityStateCheckingInterval - -• `Optional` **activityStateCheckingInterval**: `number` - -#### Defined in - -[src/task/work.ts:33](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L33) - -___ - -### storageProvider - -• `Optional` **storageProvider**: [`StorageProvider`](storage_provider.StorageProvider) - -#### Defined in - -[src/task/work.ts:34](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L34) - -___ - -### networkNode - -• `Optional` **networkNode**: [`NetworkNode`](../classes/network_node.NetworkNode) - -#### Defined in - -[src/task/work.ts:35](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L35) - -___ - -### logger - -• `Optional` **logger**: [`Logger`](utils_logger_logger.Logger) - -#### Defined in - -[src/task/work.ts:36](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L36) - -___ - -### activityReadySetupFunctions - -• `Optional` **activityReadySetupFunctions**: [`Worker`](../modules/task_work#worker)\<`unknown`\>[] - -#### Defined in - -[src/task/work.ts:37](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L37) diff --git a/src/pages/docs/golem-js/reference/interfaces/utils_logger_logger.Logger.md b/src/pages/docs/golem-js/reference/interfaces/utils_logger_logger.Logger.md index baab24111..6da0aa71f 100644 --- a/src/pages/docs/golem-js/reference/interfaces/utils_logger_logger.Logger.md +++ b/src/pages/docs/golem-js/reference/interfaces/utils_logger_logger.Logger.md @@ -36,7 +36,7 @@ type: "JS API Reference" #### Defined in -[src/utils/logger/logger.ts:2](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/logger/logger.ts#L2) +[src/utils/logger/logger.ts:2](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/logger/logger.ts#L2) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[src/utils/logger/logger.ts:3](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/logger/logger.ts#L3) +[src/utils/logger/logger.ts:3](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/logger/logger.ts#L3) ▸ **debug**(`msg`, `ctx`): `void` @@ -65,7 +65,7 @@ ___ | Name | Type | | :------ | :------ | | `msg` | `string` | -| `ctx` | `Error` \| `Record`\<`string`, `unknown`\> | +| `ctx` | `unknown` | #### Returns @@ -73,7 +73,7 @@ ___ #### Defined in -[src/utils/logger/logger.ts:4](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/logger/logger.ts#L4) +[src/utils/logger/logger.ts:4](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/logger/logger.ts#L4) ___ @@ -93,7 +93,7 @@ ___ #### Defined in -[src/utils/logger/logger.ts:5](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/logger/logger.ts#L5) +[src/utils/logger/logger.ts:5](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/logger/logger.ts#L5) ▸ **info**(`msg`, `ctx`): `void` @@ -102,7 +102,7 @@ ___ | Name | Type | | :------ | :------ | | `msg` | `string` | -| `ctx` | `Error` \| `Record`\<`string`, `unknown`\> | +| `ctx` | `unknown` | #### Returns @@ -110,7 +110,7 @@ ___ #### Defined in -[src/utils/logger/logger.ts:6](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/logger/logger.ts#L6) +[src/utils/logger/logger.ts:6](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/logger/logger.ts#L6) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[src/utils/logger/logger.ts:7](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/logger/logger.ts#L7) +[src/utils/logger/logger.ts:7](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/logger/logger.ts#L7) ▸ **warn**(`msg`, `ctx`): `void` @@ -139,7 +139,7 @@ ___ | Name | Type | | :------ | :------ | | `msg` | `string` | -| `ctx` | `Error` \| `Record`\<`string`, `unknown`\> | +| `ctx` | `unknown` | #### Returns @@ -147,7 +147,7 @@ ___ #### Defined in -[src/utils/logger/logger.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/logger/logger.ts#L8) +[src/utils/logger/logger.ts:8](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/logger/logger.ts#L8) ___ @@ -167,7 +167,7 @@ ___ #### Defined in -[src/utils/logger/logger.ts:9](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/logger/logger.ts#L9) +[src/utils/logger/logger.ts:9](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/logger/logger.ts#L9) ▸ **error**(`msg`, `ctx`): `void` @@ -176,7 +176,7 @@ ___ | Name | Type | | :------ | :------ | | `msg` | `string` | -| `ctx` | `Error` \| `Record`\<`string`, `unknown`\> | +| `ctx` | `unknown` | #### Returns @@ -184,4 +184,4 @@ ___ #### Defined in -[src/utils/logger/logger.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/logger/logger.ts#L10) +[src/utils/logger/logger.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/logger/logger.ts#L10) diff --git a/src/pages/docs/golem-js/reference/interfaces/utils_yagna_identity.IdentityModel.md b/src/pages/docs/golem-js/reference/interfaces/utils_yagna_identity.IdentityModel.md deleted file mode 100644 index d3ed10868..000000000 --- a/src/pages/docs/golem-js/reference/interfaces/utils_yagna_identity.IdentityModel.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "Interface IdentityModel" -pageTitle: "Interface IdentityModel - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Interface IdentityModel within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Interface: IdentityModel - -[utils/yagna/identity](../modules/utils_yagna_identity).IdentityModel - -## Table of contents - -### Properties - -- [identity](utils_yagna_identity.IdentityModel#identity) -- [name](utils_yagna_identity.IdentityModel#name) -- [role](utils_yagna_identity.IdentityModel#role) - -## Properties - -### identity - -• **identity**: `string` - -#### Defined in - -[src/utils/yagna/identity.ts:7](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/identity.ts#L7) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[src/utils/yagna/identity.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/identity.ts#L8) - -___ - -### role - -• **role**: `string` - -#### Defined in - -[src/utils/yagna/identity.ts:9](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/identity.ts#L9) diff --git a/src/pages/docs/golem-js/reference/interfaces/task_work.CommandOptions.md b/src/pages/docs/golem-js/reference/interfaces/work_work.CommandOptions.md similarity index 56% rename from src/pages/docs/golem-js/reference/interfaces/task_work.CommandOptions.md rename to src/pages/docs/golem-js/reference/interfaces/work_work.CommandOptions.md index 61fc71959..01d3c2329 100644 --- a/src/pages/docs/golem-js/reference/interfaces/task_work.CommandOptions.md +++ b/src/pages/docs/golem-js/reference/interfaces/work_work.CommandOptions.md @@ -6,15 +6,15 @@ type: "JS API Reference" --- # Interface: CommandOptions -[task/work](../modules/task_work).CommandOptions +[work/work](../modules/work_work).CommandOptions ## Table of contents ### Properties -- [timeout](task_work.CommandOptions#timeout) -- [env](task_work.CommandOptions#env) -- [capture](task_work.CommandOptions#capture) +- [timeout](work_work.CommandOptions#timeout) +- [env](work_work.CommandOptions#env) +- [capture](work_work.CommandOptions#capture) ## Properties @@ -24,7 +24,7 @@ type: "JS API Reference" #### Defined in -[src/task/work.ts:41](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L41) +[src/work/work.ts:43](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L43) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[src/task/work.ts:42](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L42) +[src/work/work.ts:44](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L44) ___ @@ -44,4 +44,4 @@ ___ #### Defined in -[src/task/work.ts:43](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L43) +[src/work/work.ts:45](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L45) diff --git a/src/pages/docs/golem-js/reference/interfaces/work_work.WorkOptions.md b/src/pages/docs/golem-js/reference/interfaces/work_work.WorkOptions.md new file mode 100644 index 000000000..b80908445 --- /dev/null +++ b/src/pages/docs/golem-js/reference/interfaces/work_work.WorkOptions.md @@ -0,0 +1,91 @@ +--- +title: "Interface WorkOptions" +pageTitle: "Interface WorkOptions - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Interface WorkOptions within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Interface: WorkOptions + +[work/work](../modules/work_work).WorkOptions + +## Table of contents + +### Properties + +- [activityPreparingTimeout](work_work.WorkOptions#activitypreparingtimeout) +- [activityStateCheckingInterval](work_work.WorkOptions#activitystatecheckinginterval) +- [storageProvider](work_work.WorkOptions#storageprovider) +- [networkNode](work_work.WorkOptions#networknode) +- [logger](work_work.WorkOptions#logger) +- [activityReadySetupFunctions](work_work.WorkOptions#activityreadysetupfunctions) +- [yagnaOptions](work_work.WorkOptions#yagnaoptions) + +## Properties + +### activityPreparingTimeout + +• `Optional` **activityPreparingTimeout**: `number` + +#### Defined in + +[src/work/work.ts:33](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L33) + +___ + +### activityStateCheckingInterval + +• `Optional` **activityStateCheckingInterval**: `number` + +#### Defined in + +[src/work/work.ts:34](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L34) + +___ + +### storageProvider + +• `Optional` **storageProvider**: [`StorageProvider`](storage_provider.StorageProvider) + +#### Defined in + +[src/work/work.ts:35](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L35) + +___ + +### networkNode + +• `Optional` **networkNode**: [`NetworkNode`](../classes/network_node.NetworkNode) + +#### Defined in + +[src/work/work.ts:36](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L36) + +___ + +### logger + +• `Optional` **logger**: [`Logger`](utils_logger_logger.Logger) + +#### Defined in + +[src/work/work.ts:37](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L37) + +___ + +### activityReadySetupFunctions + +• `Optional` **activityReadySetupFunctions**: [`Worker`](../modules/work_work#worker)\<`unknown`\>[] + +#### Defined in + +[src/work/work.ts:38](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L38) + +___ + +### yagnaOptions + +• `Optional` **yagnaOptions**: [`YagnaOptions`](../modules/utils_yagna_yagnaApi#yagnaoptions) + +#### Defined in + +[src/work/work.ts:39](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L39) diff --git a/src/pages/docs/golem-js/reference/modules.md b/src/pages/docs/golem-js/reference/modules.md index 63c95f938..3e15b6b38 100644 --- a/src/pages/docs/golem-js/reference/modules.md +++ b/src/pages/docs/golem-js/reference/modules.md @@ -11,19 +11,24 @@ type: "JS API Reference" ### Modules - [activity/activity](modules/activity_activity) +- [activity/factory](modules/activity_factory) - [activity/results](modules/activity_results) - [agreement/agreement](modules/agreement_agreement) +- [agreement/factory](modules/agreement_factory) - [agreement/service](modules/agreement_service) - [agreement/strategy](modules/agreement_strategy) - [error/golem-error](modules/error_golem_error) - [events/events](modules/events_events) -- [executor/events](modules/executor_events) -- [executor/executor](modules/executor_executor) -- [golem\_network/golem\_network](modules/golem_network_golem_network) -- [job/job](modules/job_job) +- [experimental/golem\_network/golem\_network](modules/experimental_golem_network_golem_network) +- [experimental/job/job](modules/experimental_job_job) +- [experimental/reputation/error](modules/experimental_reputation_error) +- [experimental/reputation/system](modules/experimental_reputation_system) +- [experimental/reputation/types](modules/experimental_reputation_types) +- [gvmi/gvmiServer](modules/gvmi_gvmiServer) - [market/builder](modules/market_builder) - [market/demand](modules/market_demand) - [market/error](modules/market_error) +- [market/factory](modules/market_factory) - [market/helpers](modules/market_helpers) - [market/proposal](modules/market_proposal) - [market/proposals\_batch](modules/market_proposals_batch) @@ -33,6 +38,7 @@ type: "JS API Reference" - [network/network](modules/network_network) - [network/node](modules/network_node) - [network/service](modules/network_service) +- [network/tcpProxy](modules/network_tcpProxy) - [package/package](modules/package_package) - [payment/InvoiceProcessor](modules/payment_InvoiceProcessor) - [payment/agreement\_payment\_process](modules/payment_agreement_payment_process) @@ -48,21 +54,15 @@ type: "JS API Reference" - [storage/null](modules/storage_null) - [storage/provider](modules/storage_provider) - [storage/ws-browser](modules/storage_ws_browser) -- [task/batch](modules/task_batch) -- [task/error](modules/task_error) -- [task/process](modules/task_process) -- [task/service](modules/task_service) -- [task/task](modules/task_task) -- [task/work](modules/task_work) - [utils/env](modules/utils_env) - [utils/logger/defaultLogger](modules/utils_logger_defaultLogger) -- [utils/logger/jsonLogger](modules/utils_logger_jsonLogger) - [utils/logger/logger](modules/utils_logger_logger) - [utils/logger/nullLogger](modules/utils_logger_nullLogger) -- [utils/logger/pinoLogger](modules/utils_logger_pinoLogger) - [utils/runtimeContextChecker](modules/utils_runtimeContextChecker) +- [utils/timeout](modules/utils_timeout) - [utils/types](modules/utils_types) -- [utils/yagna/activity](modules/utils_yagna_activity) -- [utils/yagna/gsb](modules/utils_yagna_gsb) -- [utils/yagna/identity](modules/utils_yagna_identity) -- [utils/yagna/yagna](modules/utils_yagna_yagna) +- [utils/yagna/yagnaApi](modules/utils_yagna_yagnaApi) +- [work/batch](modules/work_batch) +- [work/error](modules/work_error) +- [work/process](modules/work_process) +- [work/work](modules/work_work) diff --git a/src/pages/docs/golem-js/reference/modules/activity_activity.md b/src/pages/docs/golem-js/reference/modules/activity_activity.md index 06d1ade60..f836f405d 100644 --- a/src/pages/docs/golem-js/reference/modules/activity_activity.md +++ b/src/pages/docs/golem-js/reference/modules/activity_activity.md @@ -18,5 +18,6 @@ type: "JS API Reference" ### Interfaces +- [ActivityEvents](../interfaces/activity_activity.ActivityEvents) - [ExeScriptRequest](../interfaces/activity_activity.ExeScriptRequest) - [ActivityOptions](../interfaces/activity_activity.ActivityOptions) diff --git a/src/pages/docs/golem-js/reference/modules/activity_factory.md b/src/pages/docs/golem-js/reference/modules/activity_factory.md new file mode 100644 index 000000000..49a834efa --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/activity_factory.md @@ -0,0 +1,13 @@ +--- +title: "Module activity/factory" +pageTitle: "Module activity/factory - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module activity/factory within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: activity/factory + +## Table of contents + +### Interfaces + +- [ActivityFactoryEvents](../interfaces/activity_factory.ActivityFactoryEvents) diff --git a/src/pages/docs/golem-js/reference/modules/agreement_agreement.md b/src/pages/docs/golem-js/reference/modules/agreement_agreement.md index e925f0664..06f8fc63d 100644 --- a/src/pages/docs/golem-js/reference/modules/agreement_agreement.md +++ b/src/pages/docs/golem-js/reference/modules/agreement_agreement.md @@ -10,4 +10,5 @@ type: "JS API Reference" ### Interfaces +- [AgreementEvents](../interfaces/agreement_agreement.AgreementEvents) - [ProviderInfo](../interfaces/agreement_agreement.ProviderInfo) diff --git a/src/pages/docs/golem-js/reference/modules/agreement_factory.md b/src/pages/docs/golem-js/reference/modules/agreement_factory.md new file mode 100644 index 000000000..92788d165 --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/agreement_factory.md @@ -0,0 +1,13 @@ +--- +title: "Module agreement/factory" +pageTitle: "Module agreement/factory - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module agreement/factory within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: agreement/factory + +## Table of contents + +### Interfaces + +- [AgreementFactoryEvents](../interfaces/agreement_factory.AgreementFactoryEvents) diff --git a/src/pages/docs/golem-js/reference/modules/agreement_service.md b/src/pages/docs/golem-js/reference/modules/agreement_service.md index 0b4d8227f..4980f5830 100644 --- a/src/pages/docs/golem-js/reference/modules/agreement_service.md +++ b/src/pages/docs/golem-js/reference/modules/agreement_service.md @@ -43,4 +43,4 @@ type: "JS API Reference" #### Defined in -[src/agreement/service.ts:18](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/service.ts#L18) +[src/agreement/service.ts:18](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/service.ts#L18) diff --git a/src/pages/docs/golem-js/reference/modules/agreement_strategy.md b/src/pages/docs/golem-js/reference/modules/agreement_strategy.md index 9dfc6743e..56eed181b 100644 --- a/src/pages/docs/golem-js/reference/modules/agreement_strategy.md +++ b/src/pages/docs/golem-js/reference/modules/agreement_strategy.md @@ -40,7 +40,7 @@ Default selector that selects a random provider from the pool #### Defined in -[src/agreement/strategy.ts:4](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/strategy.ts#L4) +[src/agreement/strategy.ts:4](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/strategy.ts#L4) ___ @@ -68,7 +68,7 @@ Selector selecting a random provider from the pool, but giving priority to those #### Defined in -[src/agreement/strategy.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/strategy.ts#L8) +[src/agreement/strategy.ts:8](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/strategy.ts#L8) ___ @@ -102,4 +102,4 @@ Selector selecting the provider according to the provided list of scores #### Defined in -[src/agreement/strategy.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/agreement/strategy.ts#L17) +[src/agreement/strategy.ts:17](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/agreement/strategy.ts#L17) diff --git a/src/pages/docs/golem-js/reference/modules/events_events.md b/src/pages/docs/golem-js/reference/modules/events_events.md index 6e6b41cff..48d3b110e 100644 --- a/src/pages/docs/golem-js/reference/modules/events_events.md +++ b/src/pages/docs/golem-js/reference/modules/events_events.md @@ -11,13 +11,6 @@ type: "JS API Reference" ### Classes - [BaseEvent](../classes/events_events.BaseEvent) -- [ComputationStarted](../classes/events_events.ComputationStarted) -- [ComputationFinished](../classes/events_events.ComputationFinished) -- [ComputationFailed](../classes/events_events.ComputationFailed) -- [TaskStarted](../classes/events_events.TaskStarted) -- [TaskRedone](../classes/events_events.TaskRedone) -- [TaskRejected](../classes/events_events.TaskRejected) -- [TaskFinished](../classes/events_events.TaskFinished) - [AllocationCreated](../classes/events_events.AllocationCreated) - [DemandSubscribed](../classes/events_events.DemandSubscribed) - [DemandFailed](../classes/events_events.DemandFailed) @@ -58,4 +51,4 @@ Global Event Type with which all API events will be emitted. It should be used o #### Defined in -[src/events/events.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/events/events.ts#L10) +[src/events/events.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/events/events.ts#L10) diff --git a/src/pages/docs/golem-js/reference/modules/executor_events.md b/src/pages/docs/golem-js/reference/modules/executor_events.md deleted file mode 100644 index 6b52487ce..000000000 --- a/src/pages/docs/golem-js/reference/modules/executor_events.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "Module executor/events" -pageTitle: "Module executor/events - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module executor/events within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: executor/events - -## Table of contents - -### Interfaces - -- [TaskExecutorEventsDict](../interfaces/executor_events.TaskExecutorEventsDict) diff --git a/src/pages/docs/golem-js/reference/modules/executor_executor.md b/src/pages/docs/golem-js/reference/modules/executor_executor.md deleted file mode 100644 index 7e6cb3360..000000000 --- a/src/pages/docs/golem-js/reference/modules/executor_executor.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "Module executor/executor" -pageTitle: "Module executor/executor - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module executor/executor within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: executor/executor - -## Table of contents - -### Classes - -- [TaskExecutor](../classes/executor_executor.TaskExecutor) - -### Type Aliases - -- [ExecutorOptions](executor_executor#executoroptions) -- [ExecutorOptionsMixin](executor_executor#executoroptionsmixin) -- [YagnaOptions](executor_executor#yagnaoptions) - -## Type Aliases - -### ExecutorOptions - -Ƭ **ExecutorOptions**: \{ `package?`: `string` \| [`Package`](../classes/package_package.Package) ; `taskTimeout?`: `number` ; `subnetTag?`: `string` ; `logger?`: [`Logger`](../interfaces/utils_logger_logger.Logger) ; `enableLogging?`: `boolean` ; `yagnaOptions?`: [`YagnaOptions`](executor_executor#yagnaoptions) ; `eventTarget?`: `EventTarget` ; `maxTaskRetries?`: `number` ; `storageProvider?`: [`StorageProvider`](../interfaces/storage_provider.StorageProvider) ; `activityPreparingTimeout?`: `number` ; `skipProcessSignals?`: `boolean` ; `startupTimeout?`: `number` ; `exitOnNoProposals?`: `boolean` } & `Omit`\<[`PackageOptions`](package_package#packageoptions), ``"imageHash"`` \| ``"imageTag"``\> & [`MarketOptions`](../interfaces/market_service.MarketOptions) & [`TaskServiceOptions`](../interfaces/task_service.TaskServiceOptions) & [`PaymentOptions`](../interfaces/payment_service.PaymentOptions) & [`NetworkServiceOptions`](network_service#networkserviceoptions) & [`AgreementServiceOptions`](../interfaces/agreement_service.AgreementServiceOptions) & [`WorkOptions`](../interfaces/task_work.WorkOptions) - -#### Defined in - -[src/executor/executor.ts:22](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/executor.ts#L22) - -___ - -### ExecutorOptionsMixin - -Ƭ **ExecutorOptionsMixin**: `string` \| [`ExecutorOptions`](executor_executor#executoroptions) - -Contains information needed to start executor, if string the imageHash is required, otherwise it should be a type of [ExecutorOptions](executor_executor#executoroptions) - -#### Defined in - -[src/executor/executor.ts:79](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/executor.ts#L79) - -___ - -### YagnaOptions - -Ƭ **YagnaOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `apiKey?` | `string` | -| `basePath?` | `string` | - -#### Defined in - -[src/executor/executor.ts:81](https://github.com/golemfactory/golem-js/blob/7cee55b/src/executor/executor.ts#L81) diff --git a/src/pages/docs/golem-js/reference/modules/experimental_golem_network_golem_network.md b/src/pages/docs/golem-js/reference/modules/experimental_golem_network_golem_network.md new file mode 100644 index 000000000..24711247d --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/experimental_golem_network_golem_network.md @@ -0,0 +1,27 @@ +--- +title: "Module experimental/golem_network/golem_network" +pageTitle: "Module experimental/golem_network/golem_network - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module experimental/golem_network/golem_network within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: experimental/golem\_network/golem\_network + +## Table of contents + +### Classes + +- [GolemNetwork](../classes/experimental_golem_network_golem_network.GolemNetwork) + +### Type Aliases + +- [GolemNetworkConfig](experimental_golem_network_golem_network#golemnetworkconfig) + +## Type Aliases + +### GolemNetworkConfig + +Ƭ **GolemNetworkConfig**: `Partial`\<[`RunJobOptions`](experimental_job_job#runjoboptions)\> & \{ `yagna?`: [`YagnaOptions`](utils_yagna_yagnaApi#yagnaoptions) } + +#### Defined in + +[src/experimental/golem_network/golem_network.ts:7](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/golem_network/golem_network.ts#L7) diff --git a/src/pages/docs/golem-js/reference/modules/job_job.md b/src/pages/docs/golem-js/reference/modules/experimental_job_job.md similarity index 52% rename from src/pages/docs/golem-js/reference/modules/job_job.md rename to src/pages/docs/golem-js/reference/modules/experimental_job_job.md index 255c28b4d..9f01d2fe4 100644 --- a/src/pages/docs/golem-js/reference/modules/job_job.md +++ b/src/pages/docs/golem-js/reference/modules/experimental_job_job.md @@ -1,24 +1,28 @@ --- -title: "Module job/job" -pageTitle: "Module job/job - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module job/job within the golem-js SDK for the Golem Network." +title: "Module experimental/job/job" +pageTitle: "Module experimental/job/job - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module experimental/job/job within the golem-js SDK for the Golem Network." type: "JS API Reference" --- -# Module: job/job +# Module: experimental/job/job ## Table of contents +### Enumerations + +- [JobState](../enums/experimental_job_job.JobState) + ### Classes -- [Job](../classes/job_job.Job) +- [Job](../classes/experimental_job_job.Job) ### Interfaces -- [JobEventsDict](../interfaces/job_job.JobEventsDict) +- [JobEventsDict](../interfaces/experimental_job_job.JobEventsDict) ### Type Aliases -- [RunJobOptions](job_job#runjoboptions) +- [RunJobOptions](experimental_job_job#runjoboptions) ## Type Aliases @@ -36,8 +40,8 @@ type: "JS API Reference" | `network?` | `NetworkOptions` | | `package?` | [`PackageOptions`](package_package#packageoptions) | | `activity?` | [`ActivityOptions`](../interfaces/activity_activity.ActivityOptions) | -| `work?` | [`WorkOptions`](../interfaces/task_work.WorkOptions) | +| `work?` | [`WorkOptions`](../interfaces/work_work.WorkOptions) | #### Defined in -[src/job/job.ts:17](https://github.com/golemfactory/golem-js/blob/7cee55b/src/job/job.ts#L17) +[src/experimental/job/job.ts:28](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/job/job.ts#L28) diff --git a/src/pages/docs/golem-js/reference/modules/experimental_reputation_error.md b/src/pages/docs/golem-js/reference/modules/experimental_reputation_error.md new file mode 100644 index 000000000..d9b80156b --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/experimental_reputation_error.md @@ -0,0 +1,13 @@ +--- +title: "Module experimental/reputation/error" +pageTitle: "Module experimental/reputation/error - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module experimental/reputation/error within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: experimental/reputation/error + +## Table of contents + +### Classes + +- [GolemReputationError](../classes/experimental_reputation_error.GolemReputationError) diff --git a/src/pages/docs/golem-js/reference/modules/experimental_reputation_system.md b/src/pages/docs/golem-js/reference/modules/experimental_reputation_system.md new file mode 100644 index 000000000..825e556ed --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/experimental_reputation_system.md @@ -0,0 +1,83 @@ +--- +title: "Module experimental/reputation/system" +pageTitle: "Module experimental/reputation/system - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module experimental/reputation/system within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: experimental/reputation/system + +## Table of contents + +### Classes + +- [ReputationSystem](../classes/experimental_reputation_system.ReputationSystem) + +### Variables + +- [DEFAULT\_PROPOSAL\_MIN\_SCORE](experimental_reputation_system#default_proposal_min_score) +- [DEFAULT\_PROPOSAL\_WEIGHTS](experimental_reputation_system#default_proposal_weights) +- [DEFAULT\_AGREEMENT\_WEIGHTS](experimental_reputation_system#default_agreement_weights) +- [DEFAULT\_REPUTATION\_URL](experimental_reputation_system#default_reputation_url) +- [DEFAULT\_AGREEMENT\_TOP\_POOL\_SIZE](experimental_reputation_system#default_agreement_top_pool_size) + +## Variables + +### DEFAULT\_PROPOSAL\_MIN\_SCORE + +• `Const` **DEFAULT\_PROPOSAL\_MIN\_SCORE**: ``0.8`` + +Default minimum score for proposals. + +#### Defined in + +[src/experimental/reputation/system.ts:22](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L22) + +___ + +### DEFAULT\_PROPOSAL\_WEIGHTS + +• `Const` **DEFAULT\_PROPOSAL\_WEIGHTS**: [`ReputationWeights`](experimental_reputation_types#reputationweights) + +Default weights used to calculate the score for proposals. + +#### Defined in + +[src/experimental/reputation/system.ts:28](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L28) + +___ + +### DEFAULT\_AGREEMENT\_WEIGHTS + +• `Const` **DEFAULT\_AGREEMENT\_WEIGHTS**: [`ReputationWeights`](experimental_reputation_types#reputationweights) + +Default weights used to calculate the score for agreements. + +#### Defined in + +[src/experimental/reputation/system.ts:37](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L37) + +___ + +### DEFAULT\_REPUTATION\_URL + +• `Const` **DEFAULT\_REPUTATION\_URL**: ``"https://reputation.dev-test.golem.network/v2/providers/scores"`` + +Default reputation service URL. + +#### Defined in + +[src/experimental/reputation/system.ts:46](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L46) + +___ + +### DEFAULT\_AGREEMENT\_TOP\_POOL\_SIZE + +• `Const` **DEFAULT\_AGREEMENT\_TOP\_POOL\_SIZE**: ``2`` + +The number of top scoring providers to consider when selecting an agreement. + +Default for `topPoolSize` agreement selector option. + +#### Defined in + +[src/experimental/reputation/system.ts:53](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/system.ts#L53) diff --git a/src/pages/docs/golem-js/reference/modules/experimental_reputation_types.md b/src/pages/docs/golem-js/reference/modules/experimental_reputation_types.md new file mode 100644 index 000000000..fe783ed62 --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/experimental_reputation_types.md @@ -0,0 +1,37 @@ +--- +title: "Module experimental/reputation/types" +pageTitle: "Module experimental/reputation/types - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module experimental/reputation/types within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: experimental/reputation/types + +## Table of contents + +### Interfaces + +- [ReputationProviderScores](../interfaces/experimental_reputation_types.ReputationProviderScores) +- [ReputationProviderEntry](../interfaces/experimental_reputation_types.ReputationProviderEntry) +- [ReputationRejectedOperator](../interfaces/experimental_reputation_types.ReputationRejectedOperator) +- [ReputationRejectedProvider](../interfaces/experimental_reputation_types.ReputationRejectedProvider) +- [ReputationUntestedProvider](../interfaces/experimental_reputation_types.ReputationUntestedProvider) +- [ReputationData](../interfaces/experimental_reputation_types.ReputationData) +- [ProposalFilterOptions](../interfaces/experimental_reputation_types.ProposalFilterOptions) +- [AgreementSelectorOption](../interfaces/experimental_reputation_types.AgreementSelectorOption) +- [ReputationConfig](../interfaces/experimental_reputation_types.ReputationConfig) + +### Type Aliases + +- [ReputationWeights](experimental_reputation_types#reputationweights) + +## Type Aliases + +### ReputationWeights + +Ƭ **ReputationWeights**: `Partial`\<[`ReputationProviderScores`](../interfaces/experimental_reputation_types.ReputationProviderScores)\> + +Weights used to calculate the score for providers. + +#### Defined in + +[src/experimental/reputation/types.ts:117](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/experimental/reputation/types.ts#L117) diff --git a/src/pages/docs/golem-js/reference/modules/golem_network_golem_network.md b/src/pages/docs/golem-js/reference/modules/golem_network_golem_network.md deleted file mode 100644 index 52f6afa8f..000000000 --- a/src/pages/docs/golem-js/reference/modules/golem_network_golem_network.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "Module golem_network/golem_network" -pageTitle: "Module golem_network/golem_network - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module golem_network/golem_network within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: golem\_network/golem\_network - -## Table of contents - -### Classes - -- [GolemNetwork](../classes/golem_network_golem_network.GolemNetwork) - -### Type Aliases - -- [GolemNetworkConfig](golem_network_golem_network#golemnetworkconfig) - -## Type Aliases - -### GolemNetworkConfig - -Ƭ **GolemNetworkConfig**: `Partial`\<[`RunJobOptions`](job_job#runjoboptions)\> & \{ `yagna?`: [`YagnaOptions`](executor_executor#yagnaoptions) } - -#### Defined in - -[src/golem_network/golem_network.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/golem_network/golem_network.ts#L8) diff --git a/src/pages/docs/golem-js/reference/modules/gvmi_gvmiServer.md b/src/pages/docs/golem-js/reference/modules/gvmi_gvmiServer.md new file mode 100644 index 000000000..027afd4a7 --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/gvmi_gvmiServer.md @@ -0,0 +1,51 @@ +--- +title: "Module gvmi/gvmiServer" +pageTitle: "Module gvmi/gvmiServer - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module gvmi/gvmiServer within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: gvmi/gvmiServer + +## Table of contents + +### Classes + +- [GvmiServer](../classes/gvmi_gvmiServer.GvmiServer) + +### Functions + +- [serveLocalGvmi](gvmi_gvmiServer#servelocalgvmi) + +## Functions + +### serveLocalGvmi + +▸ **serveLocalGvmi**(`gvmiPath`, `storageProvider?`): [`GvmiServer`](../classes/gvmi_gvmiServer.GvmiServer) + +Serve a local gvmi file so a provider can download it directly from you. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `gvmiPath` | `string` | +| `storageProvider?` | [`StorageProvider`](../interfaces/storage_provider.StorageProvider) | + +#### Returns + +[`GvmiServer`](../classes/gvmi_gvmiServer.GvmiServer) + +**`Example`** + +```ts +const server = serveLocalGvmi("/path/to/your.gvmi"); +const { url, hash } = server.getImage(); +const package = Package.create({ + imageHash: hash, + imageUrl: url, +}); +``` + +#### Defined in + +[src/gvmi/gvmiServer.ts:72](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/gvmi/gvmiServer.ts#L72) diff --git a/src/pages/docs/golem-js/reference/modules/market_builder.md b/src/pages/docs/golem-js/reference/modules/market_builder.md index 7ea0748ff..e0685e717 100644 --- a/src/pages/docs/golem-js/reference/modules/market_builder.md +++ b/src/pages/docs/golem-js/reference/modules/market_builder.md @@ -29,4 +29,4 @@ Properties and constraints to be added to a market object (i.e. a demand or an o #### Defined in -[src/market/builder.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/builder.ts#L8) +[src/market/builder.ts:7](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/builder.ts#L7) diff --git a/src/pages/docs/golem-js/reference/modules/market_demand.md b/src/pages/docs/golem-js/reference/modules/market_demand.md index 6f9260866..c4ea9bc56 100644 --- a/src/pages/docs/golem-js/reference/modules/market_demand.md +++ b/src/pages/docs/golem-js/reference/modules/market_demand.md @@ -10,5 +10,6 @@ type: "JS API Reference" ### Interfaces +- [DemandEvents](../interfaces/market_demand.DemandEvents) - [DemandDetails](../interfaces/market_demand.DemandDetails) - [DemandOptions](../interfaces/market_demand.DemandOptions) diff --git a/src/pages/docs/golem-js/reference/modules/market_factory.md b/src/pages/docs/golem-js/reference/modules/market_factory.md new file mode 100644 index 000000000..e22712967 --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/market_factory.md @@ -0,0 +1,13 @@ +--- +title: "Module market/factory" +pageTitle: "Module market/factory - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module market/factory within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: market/factory + +## Table of contents + +### Interfaces + +- [DemandFactoryEvents](../interfaces/market_factory.DemandFactoryEvents) diff --git a/src/pages/docs/golem-js/reference/modules/market_helpers.md b/src/pages/docs/golem-js/reference/modules/market_helpers.md index c7d8eb0a7..cf48c76b1 100644 --- a/src/pages/docs/golem-js/reference/modules/market_helpers.md +++ b/src/pages/docs/golem-js/reference/modules/market_helpers.md @@ -30,4 +30,4 @@ An array with Golem Node IDs of the whitelisted providers. #### Defined in -[src/market/helpers.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/helpers.ts#L10) +[src/market/helpers.ts:10](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/helpers.ts#L10) diff --git a/src/pages/docs/golem-js/reference/modules/market_proposal.md b/src/pages/docs/golem-js/reference/modules/market_proposal.md index 9f7a10807..ac3af9fc1 100644 --- a/src/pages/docs/golem-js/reference/modules/market_proposal.md +++ b/src/pages/docs/golem-js/reference/modules/market_proposal.md @@ -14,6 +14,7 @@ type: "JS API Reference" ### Interfaces +- [ProposalEvents](../interfaces/market_proposal.ProposalEvents) - [ProposalDetails](../interfaces/market_proposal.ProposalDetails) ### Type Aliases @@ -37,14 +38,14 @@ type: "JS API Reference" #### Defined in -[src/market/proposal.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L8) +[src/market/proposal.ts:14](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L14) ___ ### ProposalProperties -Ƭ **ProposalProperties**: `Record`\<`string`, `string` \| `number` \| `string`[] \| `number`[] \| `boolean`\> & \{ `golem.activity.caps.transfer.protocol`: `string`[] ; `golem.com.payment.debit-notes.accept-timeout?`: `number` ; `golem.com.payment.platform.erc20-polygon-glm.address?`: `string` ; `golem.com.payment.platform.erc20-goerli-tglm.address?`: `string` ; `golem.com.payment.platform.erc20-mumbai-tglm.address?`: `string` ; `golem.com.pricing.model`: ``"linear"`` ; `golem.com.pricing.model.linear.coeffs`: `number`[] ; `golem.com.scheme`: `string` ; `golem.com.scheme.payu.debit-note.interval-sec??`: `number` ; `golem.com.scheme.payu.payment-timeout-sec??`: `number` ; `golem.com.usage.vector`: `string`[] ; `golem.inf.cpu.architecture`: `string` ; `golem.inf.cpu.brand`: `string` ; `golem.inf.cpu.capabilities`: `string`[] ; `golem.inf.cpu.cores`: `number` ; `golem.inf.cpu.model`: `string` ; `golem.inf.cpu.threads`: `number` ; `golem.inf.cpu.vendor`: `string`[] ; `golem.inf.mem.gib`: `number` ; `golem.inf.storage.gib`: `number` ; `golem.node.debug.subnet`: `string` ; `golem.node.id.name`: `string` ; `golem.node.net.is-public`: `boolean` ; `golem.runtime.capabilities`: `string`[] ; `golem.runtime.name`: `string` ; `golem.runtime.version`: `string` ; `golem.srv.caps.multi-activity`: `boolean` ; `golem.srv.caps.payload-manifest`: `boolean` } +Ƭ **ProposalProperties**: `Record`\<`string`, `string` \| `number` \| `string`[] \| `number`[] \| `boolean`\> & \{ `golem.activity.caps.transfer.protocol`: `string`[] ; `golem.com.payment.debit-notes.accept-timeout?`: `number` ; `golem.com.payment.platform.erc20-polygon-glm.address?`: `string` ; `golem.com.payment.platform.erc20-holesky-tglm.address?`: `string` ; `golem.com.payment.platform.erc20-mumbai-tglm.address?`: `string` ; `golem.com.pricing.model`: ``"linear"`` ; `golem.com.pricing.model.linear.coeffs`: `number`[] ; `golem.com.scheme`: `string` ; `golem.com.scheme.payu.debit-note.interval-sec??`: `number` ; `golem.com.scheme.payu.payment-timeout-sec??`: `number` ; `golem.com.usage.vector`: `string`[] ; `golem.inf.cpu.architecture`: `string` ; `golem.inf.cpu.brand`: `string` ; `golem.inf.cpu.capabilities`: `string`[] ; `golem.inf.cpu.cores`: `number` ; `golem.inf.cpu.model`: `string` ; `golem.inf.cpu.threads`: `number` ; `golem.inf.cpu.vendor`: `string`[] ; `golem.inf.mem.gib`: `number` ; `golem.inf.storage.gib`: `number` ; `golem.node.debug.subnet`: `string` ; `golem.node.id.name`: `string` ; `golem.node.net.is-public`: `boolean` ; `golem.runtime.capabilities`: `string`[] ; `golem.runtime.name`: `string` ; `golem.runtime.version`: `string` ; `golem.srv.caps.multi-activity`: `boolean` ; `golem.srv.caps.payload-manifest`: `boolean` } #### Defined in -[src/market/proposal.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposal.ts#L15) +[src/market/proposal.ts:21](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposal.ts#L21) diff --git a/src/pages/docs/golem-js/reference/modules/market_proposals_batch.md b/src/pages/docs/golem-js/reference/modules/market_proposals_batch.md index 9308fabaa..53ab90b4e 100644 --- a/src/pages/docs/golem-js/reference/modules/market_proposals_batch.md +++ b/src/pages/docs/golem-js/reference/modules/market_proposals_batch.md @@ -31,4 +31,4 @@ type: "JS API Reference" #### Defined in -[src/market/proposals_batch.ts:4](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/proposals_batch.ts#L4) +[src/market/proposals_batch.ts:4](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/proposals_batch.ts#L4) diff --git a/src/pages/docs/golem-js/reference/modules/market_service.md b/src/pages/docs/golem-js/reference/modules/market_service.md index 3d53bd6a6..5843d3e05 100644 --- a/src/pages/docs/golem-js/reference/modules/market_service.md +++ b/src/pages/docs/golem-js/reference/modules/market_service.md @@ -38,4 +38,4 @@ type: "JS API Reference" #### Defined in -[src/market/service.ts:11](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/service.ts#L11) +[src/market/service.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/service.ts#L12) diff --git a/src/pages/docs/golem-js/reference/modules/market_strategy.md b/src/pages/docs/golem-js/reference/modules/market_strategy.md index 21d1363e8..a501c6a43 100644 --- a/src/pages/docs/golem-js/reference/modules/market_strategy.md +++ b/src/pages/docs/golem-js/reference/modules/market_strategy.md @@ -39,7 +39,7 @@ type: "JS API Reference" #### Defined in -[src/market/strategy.ts:30](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/strategy.ts#L30) +[src/market/strategy.ts:30](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/strategy.ts#L30) ## Functions @@ -61,7 +61,7 @@ Default Proposal filter that accept all proposal coming from the market #### Defined in -[src/market/strategy.ts:4](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/strategy.ts#L4) +[src/market/strategy.ts:4](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/strategy.ts#L4) ___ @@ -95,7 +95,7 @@ Proposal filter blocking every offer coming from a provider whose id is in the a #### Defined in -[src/market/strategy.ts:7](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/strategy.ts#L7) +[src/market/strategy.ts:7](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/strategy.ts#L7) ___ @@ -129,7 +129,7 @@ Proposal filter blocking every offer coming from a provider whose name is in the #### Defined in -[src/market/strategy.ts:11](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/strategy.ts#L11) +[src/market/strategy.ts:11](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/strategy.ts#L11) ___ @@ -163,7 +163,7 @@ Proposal filter blocking every offer coming from a provider whose name match to #### Defined in -[src/market/strategy.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/strategy.ts#L15) +[src/market/strategy.ts:15](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/strategy.ts#L15) ___ @@ -197,7 +197,7 @@ Proposal filter that only allows offers from a provider whose id is in the array #### Defined in -[src/market/strategy.ts:19](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/strategy.ts#L19) +[src/market/strategy.ts:19](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/strategy.ts#L19) ___ @@ -231,7 +231,7 @@ Proposal filter that only allows offers from a provider whose name is in the arr #### Defined in -[src/market/strategy.ts:23](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/strategy.ts#L23) +[src/market/strategy.ts:23](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/strategy.ts#L23) ___ @@ -265,7 +265,7 @@ Proposal filter that only allows offers from a provider whose name match to the #### Defined in -[src/market/strategy.ts:27](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/strategy.ts#L27) +[src/market/strategy.ts:27](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/strategy.ts#L27) ___ @@ -299,4 +299,4 @@ Proposal filter only allowing offers that do not exceed the defined usage #### Defined in -[src/market/strategy.ts:43](https://github.com/golemfactory/golem-js/blob/7cee55b/src/market/strategy.ts#L43) +[src/market/strategy.ts:43](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/market/strategy.ts#L43) diff --git a/src/pages/docs/golem-js/reference/modules/network_service.md b/src/pages/docs/golem-js/reference/modules/network_service.md index 267679788..cc44e8fea 100644 --- a/src/pages/docs/golem-js/reference/modules/network_service.md +++ b/src/pages/docs/golem-js/reference/modules/network_service.md @@ -20,4 +20,4 @@ type: "JS API Reference" #### Defined in -[src/network/service.ts:7](https://github.com/golemfactory/golem-js/blob/7cee55b/src/network/service.ts#L7) +[src/network/service.ts:6](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/network/service.ts#L6) diff --git a/src/pages/docs/golem-js/reference/modules/network_tcpProxy.md b/src/pages/docs/golem-js/reference/modules/network_tcpProxy.md new file mode 100644 index 000000000..50c04353b --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/network_tcpProxy.md @@ -0,0 +1,13 @@ +--- +title: "Module network/tcpProxy" +pageTitle: "Module network/tcpProxy - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module network/tcpProxy within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: network/tcpProxy + +## Table of contents + +### Classes + +- [TcpProxy](../classes/network_tcpProxy.TcpProxy) diff --git a/src/pages/docs/golem-js/reference/modules/package_package.md b/src/pages/docs/golem-js/reference/modules/package_package.md index ba6aa90f2..d24a1181a 100644 --- a/src/pages/docs/golem-js/reference/modules/package_package.md +++ b/src/pages/docs/golem-js/reference/modules/package_package.md @@ -44,17 +44,18 @@ type: "JS API Reference" | `manifestSigAlgorithm?` | `string` | Algorithm of manifest signature, e.g. "sha256" * | | `manifestCert?` | `string` | Certificate - base64 encoded public certificate (DER or PEM) matching key used to generate signature * | | `logger?` | [`Logger`](../interfaces/utils_logger_logger.Logger) | - | +| `imageUrl` | `string` | If you want a provider to download the image from your your local filesystem or a different registry than the default one, you can provide the image url here. Note that to use this option you need to also provide the image SHA3-224 hash. | #### Defined in -[src/package/package.ts:7](https://github.com/golemfactory/golem-js/blob/7cee55b/src/package/package.ts#L7) +[src/package/package.ts:7](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/package/package.ts#L7) ___ ### PackageOptions -Ƭ **PackageOptions**: [`RequireAtLeastOne`](utils_types#requireatleastone)\<[`AllPackageOptions`](package_package#allpackageoptions), ``"imageHash"`` \| ``"imageTag"`` \| ``"manifest"``\> +Ƭ **PackageOptions**: [`RequireAtLeastOne`](utils_types#requireatleastone)\<[`AllPackageOptions`](package_package#allpackageoptions), ``"imageHash"`` \| ``"imageTag"`` \| ``"manifest"`` \| ``"imageUrl"``\> #### Defined in -[src/package/package.ts:34](https://github.com/golemfactory/golem-js/blob/7cee55b/src/package/package.ts#L34) +[src/package/package.ts:40](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/package/package.ts#L40) diff --git a/src/pages/docs/golem-js/reference/modules/payment_InvoiceProcessor.md b/src/pages/docs/golem-js/reference/modules/payment_InvoiceProcessor.md index d923fabf1..3805c888d 100644 --- a/src/pages/docs/golem-js/reference/modules/payment_InvoiceProcessor.md +++ b/src/pages/docs/golem-js/reference/modules/payment_InvoiceProcessor.md @@ -20,8 +20,8 @@ type: "JS API Reference" ### InvoiceAcceptResult -Ƭ **InvoiceAcceptResult**: \{ `invoiceId`: `string` ; `allocation`: `Allocation` ; `success`: ``true`` ; `amount`: `string` ; `dryRun`: `boolean` } \| \{ `invoiceId`: `string` ; `allocation`: `Allocation` ; `success`: ``false`` ; `amount`: `string` ; `reason`: `unknown` ; `dryRun`: `boolean` } +Ƭ **InvoiceAcceptResult**: \{ `invoiceId`: `string` ; `allocation`: `PaymentApi.AllocationDTO` ; `success`: ``true`` ; `amount`: `string` ; `dryRun`: `boolean` } \| \{ `invoiceId`: `string` ; `allocation`: `PaymentApi.AllocationDTO` ; `success`: ``false`` ; `amount`: `string` ; `reason`: `unknown` ; `dryRun`: `boolean` } #### Defined in -[src/payment/InvoiceProcessor.ts:6](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/InvoiceProcessor.ts#L6) +[src/payment/InvoiceProcessor.ts:5](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/InvoiceProcessor.ts#L5) diff --git a/src/pages/docs/golem-js/reference/modules/payment_debit_note.md b/src/pages/docs/golem-js/reference/modules/payment_debit_note.md index 5af49d32d..fd42e54e6 100644 --- a/src/pages/docs/golem-js/reference/modules/payment_debit_note.md +++ b/src/pages/docs/golem-js/reference/modules/payment_debit_note.md @@ -10,6 +10,7 @@ type: "JS API Reference" ### Interfaces +- [DebitNoteEvents](../interfaces/payment_debit_note.DebitNoteEvents) - [DebitNoteDTO](../interfaces/payment_debit_note.DebitNoteDTO) ### Type Aliases @@ -24,4 +25,4 @@ type: "JS API Reference" #### Defined in -[src/payment/debit_note.ts:11](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/debit_note.ts#L11) +[src/payment/debit_note.ts:16](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/debit_note.ts#L16) diff --git a/src/pages/docs/golem-js/reference/modules/payment_invoice.md b/src/pages/docs/golem-js/reference/modules/payment_invoice.md index 305bb711e..3cdc6c907 100644 --- a/src/pages/docs/golem-js/reference/modules/payment_invoice.md +++ b/src/pages/docs/golem-js/reference/modules/payment_invoice.md @@ -10,6 +10,7 @@ type: "JS API Reference" ### Interfaces +- [InvoiceEvents](../interfaces/payment_invoice.InvoiceEvents) - [InvoiceDTO](../interfaces/payment_invoice.InvoiceDTO) ### Type Aliases @@ -24,4 +25,4 @@ type: "JS API Reference" #### Defined in -[src/payment/invoice.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/invoice.ts#L10) +[src/payment/invoice.ts:15](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/invoice.ts#L15) diff --git a/src/pages/docs/golem-js/reference/modules/payment_payments.md b/src/pages/docs/golem-js/reference/modules/payment_payments.md index 40d76e053..5ccb0f42c 100644 --- a/src/pages/docs/golem-js/reference/modules/payment_payments.md +++ b/src/pages/docs/golem-js/reference/modules/payment_payments.md @@ -14,18 +14,5 @@ type: "JS API Reference" ### Interfaces +- [PaymentEvents](../interfaces/payment_payments.PaymentEvents) - [PaymentOptions](../interfaces/payment_payments.PaymentOptions) - -### Variables - -- [PAYMENT\_EVENT\_TYPE](payment_payments#payment_event_type) - -## Variables - -### PAYMENT\_EVENT\_TYPE - -• `Const` **PAYMENT\_EVENT\_TYPE**: ``"PaymentReceived"`` - -#### Defined in - -[src/payment/payments.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/payments.ts#L15) diff --git a/src/pages/docs/golem-js/reference/modules/payment_service.md b/src/pages/docs/golem-js/reference/modules/payment_service.md index 029879b61..231ddd9c7 100644 --- a/src/pages/docs/golem-js/reference/modules/payment_service.md +++ b/src/pages/docs/golem-js/reference/modules/payment_service.md @@ -10,6 +10,7 @@ type: "JS API Reference" ### Interfaces +- [PaymentServiceEvents](../interfaces/payment_service.PaymentServiceEvents) - [PaymentOptions](../interfaces/payment_service.PaymentOptions) ### Type Aliases @@ -39,7 +40,7 @@ type: "JS API Reference" #### Defined in -[src/payment/service.ts:37](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/service.ts#L37) +[src/payment/service.ts:38](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/service.ts#L38) ___ @@ -63,4 +64,4 @@ ___ #### Defined in -[src/payment/service.ts:38](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/service.ts#L38) +[src/payment/service.ts:39](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/service.ts#L39) diff --git a/src/pages/docs/golem-js/reference/modules/payment_strategy.md b/src/pages/docs/golem-js/reference/modules/payment_strategy.md index 2cb122645..5c9f68539 100644 --- a/src/pages/docs/golem-js/reference/modules/payment_strategy.md +++ b/src/pages/docs/golem-js/reference/modules/payment_strategy.md @@ -35,7 +35,7 @@ Default DebitNotes filter that accept all debit notes without any validation #### Defined in -[src/payment/strategy.ts:5](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/strategy.ts#L5) +[src/payment/strategy.ts:6](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/strategy.ts#L6) ___ @@ -57,7 +57,7 @@ Default Invoices filter that accept all invoices without any validation #### Defined in -[src/payment/strategy.ts:7](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/strategy.ts#L7) +[src/payment/strategy.ts:9](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/strategy.ts#L9) ___ @@ -91,7 +91,7 @@ A custom filter that only accepts debit notes below a given value #### Defined in -[src/payment/strategy.ts:10](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/strategy.ts#L10) +[src/payment/strategy.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/strategy.ts#L12) ___ @@ -125,4 +125,4 @@ A custom filter that only accepts invoices below a given value #### Defined in -[src/payment/strategy.ts:14](https://github.com/golemfactory/golem-js/blob/7cee55b/src/payment/strategy.ts#L14) +[src/payment/strategy.ts:16](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/payment/strategy.ts#L16) diff --git a/src/pages/docs/golem-js/reference/modules/script_command.md b/src/pages/docs/golem-js/reference/modules/script_command.md index 6fd0d88bf..dd4c919a8 100644 --- a/src/pages/docs/golem-js/reference/modules/script_command.md +++ b/src/pages/docs/golem-js/reference/modules/script_command.md @@ -34,7 +34,7 @@ type: "JS API Reference" #### Defined in -[src/script/command.ts:76](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L76) +[src/script/command.ts:80](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L80) ___ @@ -44,6 +44,6 @@ ___ #### Defined in -[src/script/command.ts:80](https://github.com/golemfactory/golem-js/blob/7cee55b/src/script/command.ts#L80) +[src/script/command.ts:84](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/script/command.ts#L84) ___ diff --git a/src/pages/docs/golem-js/reference/modules/storage_provider.md b/src/pages/docs/golem-js/reference/modules/storage_provider.md index 11514c41b..ef8af3719 100644 --- a/src/pages/docs/golem-js/reference/modules/storage_provider.md +++ b/src/pages/docs/golem-js/reference/modules/storage_provider.md @@ -38,4 +38,4 @@ type: "JS API Reference" #### Defined in -[src/storage/provider.ts:1](https://github.com/golemfactory/golem-js/blob/7cee55b/src/storage/provider.ts#L1) +[src/storage/provider.ts:1](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/storage/provider.ts#L1) diff --git a/src/pages/docs/golem-js/reference/modules/task_batch.md b/src/pages/docs/golem-js/reference/modules/task_batch.md deleted file mode 100644 index bab311dfe..000000000 --- a/src/pages/docs/golem-js/reference/modules/task_batch.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "Module task/batch" -pageTitle: "Module task/batch - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module task/batch within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: task/batch - -## Table of contents - -### Classes - -- [Batch](../classes/task_batch.Batch) diff --git a/src/pages/docs/golem-js/reference/modules/task_error.md b/src/pages/docs/golem-js/reference/modules/task_error.md deleted file mode 100644 index 3a7eee4b1..000000000 --- a/src/pages/docs/golem-js/reference/modules/task_error.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "Module task/error" -pageTitle: "Module task/error - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module task/error within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: task/error - -## Table of contents - -### Enumerations - -- [WorkErrorCode](../enums/task_error.WorkErrorCode) - -### Classes - -- [GolemWorkError](../classes/task_error.GolemWorkError) diff --git a/src/pages/docs/golem-js/reference/modules/task_process.md b/src/pages/docs/golem-js/reference/modules/task_process.md deleted file mode 100644 index e4580aa82..000000000 --- a/src/pages/docs/golem-js/reference/modules/task_process.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "Module task/process" -pageTitle: "Module task/process - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module task/process within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: task/process - -## Table of contents - -### Classes - -- [RemoteProcess](../classes/task_process.RemoteProcess) diff --git a/src/pages/docs/golem-js/reference/modules/task_service.md b/src/pages/docs/golem-js/reference/modules/task_service.md deleted file mode 100644 index 6e92310cc..000000000 --- a/src/pages/docs/golem-js/reference/modules/task_service.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "Module task/service" -pageTitle: "Module task/service - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module task/service within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: task/service - -## Table of contents - -### Interfaces - -- [TaskServiceOptions](../interfaces/task_service.TaskServiceOptions) diff --git a/src/pages/docs/golem-js/reference/modules/task_task.md b/src/pages/docs/golem-js/reference/modules/task_task.md deleted file mode 100644 index 64897d5f5..000000000 --- a/src/pages/docs/golem-js/reference/modules/task_task.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "Module task/task" -pageTitle: "Module task/task - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module task/task within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: task/task - -## Table of contents - -### Enumerations - -- [TaskState](../enums/task_task.TaskState) - -### Classes - -- [Task](../classes/task_task.Task) - -### Type Aliases - -- [TaskOptions](task_task#taskoptions) - -## Type Aliases - -### TaskOptions - -Ƭ **TaskOptions**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `maxRetries?` | `number` | maximum number of retries if task failed due to provider reason, default = 5 | -| `timeout?` | `number` | timeout in ms for task execution, including retries, default = 300_000 (5min) | -| `activityReadySetupFunctions?` | [`Worker`](task_work#worker)\<`unknown`\>[] | array of setup functions to run on each activity | - -#### Defined in - -[src/task/task.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/task.ts#L16) diff --git a/src/pages/docs/golem-js/reference/modules/task_work.md b/src/pages/docs/golem-js/reference/modules/task_work.md deleted file mode 100644 index e6d2386d6..000000000 --- a/src/pages/docs/golem-js/reference/modules/task_work.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "Module task/work" -pageTitle: "Module task/work - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module task/work within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: task/work - -## Table of contents - -### Classes - -- [WorkContext](../classes/task_work.WorkContext) - -### Interfaces - -- [WorkOptions](../interfaces/task_work.WorkOptions) -- [CommandOptions](../interfaces/task_work.CommandOptions) - -### Type Aliases - -- [Worker](task_work#worker) - -## Type Aliases - -### Worker - -Ƭ **Worker**\<`OutputType`\>: (`ctx`: [`WorkContext`](../classes/task_work.WorkContext)) => `Promise`\<`OutputType`\> - -#### Type parameters - -| Name | -| :------ | -| `OutputType` | - -#### Type declaration - -▸ (`ctx`): `Promise`\<`OutputType`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `ctx` | [`WorkContext`](../classes/task_work.WorkContext) | - -##### Returns - -`Promise`\<`OutputType`\> - -#### Defined in - -[src/task/work.ts:24](https://github.com/golemfactory/golem-js/blob/7cee55b/src/task/work.ts#L24) diff --git a/src/pages/docs/golem-js/reference/modules/utils_env.md b/src/pages/docs/golem-js/reference/modules/utils_env.md index 061ecc172..4ddc1b376 100644 --- a/src/pages/docs/golem-js/reference/modules/utils_env.md +++ b/src/pages/docs/golem-js/reference/modules/utils_env.md @@ -29,7 +29,7 @@ type: "JS API Reference" #### Defined in -[src/utils/env.ts:3](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/env.ts#L3) +[src/utils/env.ts:3](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/env.ts#L3) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[src/utils/env.ts:7](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/env.ts#L7) +[src/utils/env.ts:7](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/env.ts#L7) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[src/utils/env.ts:11](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/env.ts#L11) +[src/utils/env.ts:11](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/env.ts#L11) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[src/utils/env.ts:15](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/env.ts#L15) +[src/utils/env.ts:15](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/env.ts#L15) ___ @@ -85,7 +85,7 @@ ___ #### Defined in -[src/utils/env.ts:21](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/env.ts#L21) +[src/utils/env.ts:21](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/env.ts#L21) ___ @@ -99,4 +99,4 @@ ___ #### Defined in -[src/utils/env.ts:25](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/env.ts#L25) +[src/utils/env.ts:25](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/env.ts#L25) diff --git a/src/pages/docs/golem-js/reference/modules/utils_logger_defaultLogger.md b/src/pages/docs/golem-js/reference/modules/utils_logger_defaultLogger.md index 05834a360..c821f7e89 100644 --- a/src/pages/docs/golem-js/reference/modules/utils_logger_defaultLogger.md +++ b/src/pages/docs/golem-js/reference/modules/utils_logger_defaultLogger.md @@ -16,16 +16,18 @@ type: "JS API Reference" ### defaultLogger -▸ **defaultLogger**(`namespace`): `Object` +▸ **defaultLogger**(`namespace`, `opts?`): `Object` Creates a logger that uses the debug library. This logger is used by default by all entities in the SDK. -If the namespace is not prefixed with `golem-js:`, it will be prefixed automatically. + +If the namespace is not prefixed with `golem-js:`, it will be prefixed automatically - this can be controlled by `disableAutoPrefix` options. #### Parameters | Name | Type | | :------ | :------ | | `namespace` | `string` | +| `opts` | `DefaultLoggerOptions` | #### Returns @@ -42,4 +44,4 @@ If the namespace is not prefixed with `golem-js:`, it will be prefixed automatic #### Defined in -[src/utils/logger/defaultLogger.ts:7](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/logger/defaultLogger.ts#L7) +[src/utils/logger/defaultLogger.ts:25](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/logger/defaultLogger.ts#L25) diff --git a/src/pages/docs/golem-js/reference/modules/utils_logger_jsonLogger.md b/src/pages/docs/golem-js/reference/modules/utils_logger_jsonLogger.md deleted file mode 100644 index 94ec7d354..000000000 --- a/src/pages/docs/golem-js/reference/modules/utils_logger_jsonLogger.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "Module utils/logger/jsonLogger" -pageTitle: "Module utils/logger/jsonLogger - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module utils/logger/jsonLogger within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: utils/logger/jsonLogger - -## Table of contents - -### Functions - -- [jsonLogger](utils_logger_jsonLogger#jsonlogger) - -## Functions - -### jsonLogger - -▸ **jsonLogger**(`filename?`): [`Logger`](../interfaces/utils_logger_logger.Logger) - -Create a logger that writes a JSON object for every log line. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filename?` | `string` | path to the file to write to, if not specified, logs are written to stdout | - -#### Returns - -[`Logger`](../interfaces/utils_logger_logger.Logger) - -#### Defined in - -[src/utils/logger/jsonLogger.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/logger/jsonLogger.ts#L8) diff --git a/src/pages/docs/golem-js/reference/modules/utils_logger_nullLogger.md b/src/pages/docs/golem-js/reference/modules/utils_logger_nullLogger.md index 1b2e1c790..c944c87d8 100644 --- a/src/pages/docs/golem-js/reference/modules/utils_logger_nullLogger.md +++ b/src/pages/docs/golem-js/reference/modules/utils_logger_nullLogger.md @@ -24,4 +24,4 @@ type: "JS API Reference" #### Defined in -[src/utils/logger/nullLogger.ts:3](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/logger/nullLogger.ts#L3) +[src/utils/logger/nullLogger.ts:3](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/logger/nullLogger.ts#L3) diff --git a/src/pages/docs/golem-js/reference/modules/utils_logger_pinoLogger.md b/src/pages/docs/golem-js/reference/modules/utils_logger_pinoLogger.md deleted file mode 100644 index e6b4702be..000000000 --- a/src/pages/docs/golem-js/reference/modules/utils_logger_pinoLogger.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "Module utils/logger/pinoLogger" -pageTitle: "Module utils/logger/pinoLogger - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module utils/logger/pinoLogger within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: utils/logger/pinoLogger - -## Table of contents - -### Functions - -- [pinoLogger](utils_logger_pinoLogger#pinologger) - -## Functions - -### pinoLogger - -▸ **pinoLogger**(`optionsOrStream?`): [`Logger`](../interfaces/utils_logger_logger.Logger) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `optionsOrStream?` | `LoggerOptions`\<`never`\> \| `DestinationStream` | - -#### Returns - -[`Logger`](../interfaces/utils_logger_logger.Logger) - -#### Defined in - -[src/utils/logger/pinoLogger.ts:4](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/logger/pinoLogger.ts#L4) diff --git a/src/pages/docs/golem-js/reference/modules/utils_runtimeContextChecker.md b/src/pages/docs/golem-js/reference/modules/utils_runtimeContextChecker.md index 85497df5d..38b85ae46 100644 --- a/src/pages/docs/golem-js/reference/modules/utils_runtimeContextChecker.md +++ b/src/pages/docs/golem-js/reference/modules/utils_runtimeContextChecker.md @@ -20,4 +20,4 @@ type: "JS API Reference" #### Defined in -[src/utils/runtimeContextChecker.ts:8](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/runtimeContextChecker.ts#L8) +[src/utils/runtimeContextChecker.ts:8](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/runtimeContextChecker.ts#L8) diff --git a/src/pages/docs/golem-js/reference/modules/utils_timeout.md b/src/pages/docs/golem-js/reference/modules/utils_timeout.md new file mode 100644 index 000000000..2bc41aaa5 --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/utils_timeout.md @@ -0,0 +1,40 @@ +--- +title: "Module utils/timeout" +pageTitle: "Module utils/timeout - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module utils/timeout within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: utils/timeout + +## Table of contents + +### Functions + +- [withTimeout](utils_timeout#withtimeout) + +## Functions + +### withTimeout + +▸ **withTimeout**\<`T`\>(`promise`, `timeoutMs`): `Promise`\<`T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `promise` | `Promise`\<`T`\> | +| `timeoutMs` | `number` | + +#### Returns + +`Promise`\<`T`\> + +#### Defined in + +[src/utils/timeout.ts:9](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/timeout.ts#L9) diff --git a/src/pages/docs/golem-js/reference/modules/utils_types.md b/src/pages/docs/golem-js/reference/modules/utils_types.md index 4b73427f8..a01380b45 100644 --- a/src/pages/docs/golem-js/reference/modules/utils_types.md +++ b/src/pages/docs/golem-js/reference/modules/utils_types.md @@ -27,4 +27,4 @@ type: "JS API Reference" #### Defined in -[src/utils/types.ts:12](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/types.ts#L12) +[src/utils/types.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/types.ts#L12) diff --git a/src/pages/docs/golem-js/reference/modules/utils_yagna_activity.md b/src/pages/docs/golem-js/reference/modules/utils_yagna_activity.md deleted file mode 100644 index c69dcc615..000000000 --- a/src/pages/docs/golem-js/reference/modules/utils_yagna_activity.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "Module utils/yagna/activity" -pageTitle: "Module utils/yagna/activity - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module utils/yagna/activity within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: utils/yagna/activity - -## Table of contents - -### Classes - -- [RequestorApi](../classes/utils_yagna_activity.RequestorApi) diff --git a/src/pages/docs/golem-js/reference/modules/utils_yagna_gsb.md b/src/pages/docs/golem-js/reference/modules/utils_yagna_gsb.md deleted file mode 100644 index 1d4a81370..000000000 --- a/src/pages/docs/golem-js/reference/modules/utils_yagna_gsb.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "Module utils/yagna/gsb" -pageTitle: "Module utils/yagna/gsb - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module utils/yagna/gsb within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: utils/yagna/gsb - -## Table of contents - -### Classes - -- [RequestorApi](../classes/utils_yagna_gsb.RequestorApi) - -### Type Aliases - -- [ServiceModel](utils_yagna_gsb#servicemodel) -- [GftpFileInfo](utils_yagna_gsb#gftpfileinfo) - -## Type Aliases - -### ServiceModel - -Ƭ **ServiceModel**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `servicesId` | `string` | - -#### Defined in - -[src/utils/yagna/gsb.ts:5](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/gsb.ts#L5) - -___ - -### GftpFileInfo - -Ƭ **GftpFileInfo**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `url` | `string` | - -#### Defined in - -[src/utils/yagna/gsb.ts:9](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/gsb.ts#L9) diff --git a/src/pages/docs/golem-js/reference/modules/utils_yagna_identity.md b/src/pages/docs/golem-js/reference/modules/utils_yagna_identity.md deleted file mode 100644 index 98dc10113..000000000 --- a/src/pages/docs/golem-js/reference/modules/utils_yagna_identity.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "Module utils/yagna/identity" -pageTitle: "Module utils/yagna/identity - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module utils/yagna/identity within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: utils/yagna/identity - -## Table of contents - -### Classes - -- [RequestorApi](../classes/utils_yagna_identity.RequestorApi) - -### Interfaces - -- [IdentityModel](../interfaces/utils_yagna_identity.IdentityModel) diff --git a/src/pages/docs/golem-js/reference/modules/utils_yagna_yagna.md b/src/pages/docs/golem-js/reference/modules/utils_yagna_yagna.md deleted file mode 100644 index fef114d04..000000000 --- a/src/pages/docs/golem-js/reference/modules/utils_yagna_yagna.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "Module utils/yagna/yagna" -pageTitle: "Module utils/yagna/yagna - golem-js API Reference" -description: "Explore the detailed API reference documentation for the Module utils/yagna/yagna within the golem-js SDK for the Golem Network." -type: "JS API Reference" ---- -# Module: utils/yagna/yagna - -## Table of contents - -### Classes - -- [Yagna](../classes/utils_yagna_yagna.Yagna) - -### Type Aliases - -- [YagnaApi](utils_yagna_yagna#yagnaapi) -- [YagnaOptions](utils_yagna_yagna#yagnaoptions) - -### Variables - -- [MIN\_SUPPORTED\_YAGNA](utils_yagna_yagna#min_supported_yagna) - -## Type Aliases - -### YagnaApi - -Ƭ **YagnaApi**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `market` | `MarketRequestorApi` | -| `activity` | \{ `control`: `RequestorControlApi` ; `state`: [`RequestorApi`](../classes/utils_yagna_activity.RequestorApi) } | -| `activity.control` | `RequestorControlApi` | -| `activity.state` | [`RequestorApi`](../classes/utils_yagna_activity.RequestorApi) | -| `net` | `NetworkRequestorApi` | -| `payment` | `PaymentRequestorApi` | -| `identity` | [`RequestorApi`](../classes/utils_yagna_identity.RequestorApi) | -| `gsb` | [`RequestorApi`](../classes/utils_yagna_gsb.RequestorApi) | -| `yagnaOptions` | [`YagnaOptions`](utils_yagna_yagna#yagnaoptions) | -| `appSessionId` | `string` | - -#### Defined in - -[src/utils/yagna/yagna.ts:16](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L16) - -___ - -### YagnaOptions - -Ƭ **YagnaOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `apiKey?` | `string` | -| `basePath?` | `string` | -| `abortController?` | `AbortController` | - -#### Defined in - -[src/utils/yagna/yagna.ts:27](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L27) - -## Variables - -### MIN\_SUPPORTED\_YAGNA - -• `Const` **MIN\_SUPPORTED\_YAGNA**: ``"0.13.2"`` - -#### Defined in - -[src/utils/yagna/yagna.ts:52](https://github.com/golemfactory/golem-js/blob/7cee55b/src/utils/yagna/yagna.ts#L52) diff --git a/src/pages/docs/golem-js/reference/modules/utils_yagna_yagnaApi.md b/src/pages/docs/golem-js/reference/modules/utils_yagna_yagnaApi.md new file mode 100644 index 000000000..e20c215f3 --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/utils_yagna_yagnaApi.md @@ -0,0 +1,49 @@ +--- +title: "Module utils/yagna/yagnaApi" +pageTitle: "Module utils/yagna/yagnaApi - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module utils/yagna/yagnaApi within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: utils/yagna/yagnaApi + +## Table of contents + +### Classes + +- [YagnaApi](../classes/utils_yagna_yagnaApi.YagnaApi) + +### Type Aliases + +- [YagnaOptions](utils_yagna_yagnaApi#yagnaoptions) + +### Variables + +- [MIN\_SUPPORTED\_YAGNA](utils_yagna_yagnaApi#min_supported_yagna) + +## Type Aliases + +### YagnaOptions + +Ƭ **YagnaOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `apiKey?` | `string` | +| `basePath?` | `string` | +| `logger?` | [`Logger`](../interfaces/utils_logger_logger.Logger) | + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:12](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L12) + +## Variables + +### MIN\_SUPPORTED\_YAGNA + +• `Const` **MIN\_SUPPORTED\_YAGNA**: ``"0.13.2"`` + +#### Defined in + +[src/utils/yagna/yagnaApi.ts:18](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/utils/yagna/yagnaApi.ts#L18) diff --git a/src/pages/docs/golem-js/reference/modules/work_batch.md b/src/pages/docs/golem-js/reference/modules/work_batch.md new file mode 100644 index 000000000..ca04ffac4 --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/work_batch.md @@ -0,0 +1,13 @@ +--- +title: "Module work/batch" +pageTitle: "Module work/batch - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module work/batch within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: work/batch + +## Table of contents + +### Classes + +- [Batch](../classes/work_batch.Batch) diff --git a/src/pages/docs/golem-js/reference/modules/work_error.md b/src/pages/docs/golem-js/reference/modules/work_error.md new file mode 100644 index 000000000..df05cc028 --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/work_error.md @@ -0,0 +1,17 @@ +--- +title: "Module work/error" +pageTitle: "Module work/error - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module work/error within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: work/error + +## Table of contents + +### Enumerations + +- [WorkErrorCode](../enums/work_error.WorkErrorCode) + +### Classes + +- [GolemWorkError](../classes/work_error.GolemWorkError) diff --git a/src/pages/docs/golem-js/reference/modules/work_process.md b/src/pages/docs/golem-js/reference/modules/work_process.md new file mode 100644 index 000000000..2d935fc79 --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/work_process.md @@ -0,0 +1,13 @@ +--- +title: "Module work/process" +pageTitle: "Module work/process - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module work/process within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: work/process + +## Table of contents + +### Classes + +- [RemoteProcess](../classes/work_process.RemoteProcess) diff --git a/src/pages/docs/golem-js/reference/modules/work_work.md b/src/pages/docs/golem-js/reference/modules/work_work.md new file mode 100644 index 000000000..62113c258 --- /dev/null +++ b/src/pages/docs/golem-js/reference/modules/work_work.md @@ -0,0 +1,52 @@ +--- +title: "Module work/work" +pageTitle: "Module work/work - golem-js API Reference" +description: "Explore the detailed API reference documentation for the Module work/work within the golem-js SDK for the Golem Network." +type: "JS API Reference" +--- +# Module: work/work + +## Table of contents + +### Classes + +- [WorkContext](../classes/work_work.WorkContext) + +### Interfaces + +- [WorkOptions](../interfaces/work_work.WorkOptions) +- [CommandOptions](../interfaces/work_work.CommandOptions) + +### Type Aliases + +- [Worker](work_work#worker) + +## Type Aliases + +### Worker + +Ƭ **Worker**\<`OutputType`\>: (`ctx`: [`WorkContext`](../classes/work_work.WorkContext)) => `Promise`\<`OutputType`\> + +#### Type parameters + +| Name | +| :------ | +| `OutputType` | + +#### Type declaration + +▸ (`ctx`): `Promise`\<`OutputType`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `ctx` | [`WorkContext`](../classes/work_work.WorkContext) | + +##### Returns + +`Promise`\<`OutputType`\> + +#### Defined in + +[src/work/work.ts:25](https://github.com/golemfactory/golem-js/blob/8e8b5ef/src/work/work.ts#L25) diff --git a/src/pages/docs/golem-js/reference/overview.md b/src/pages/docs/golem-js/reference/overview.md index 10ada5640..4c37909ad 100644 --- a/src/pages/docs/golem-js/reference/overview.md +++ b/src/pages/docs/golem-js/reference/overview.md @@ -26,9 +26,6 @@ type: JS API Reference * [AllocationCreated](classes/events_events.AllocationCreated) * [BaseEvent](classes/events_events.BaseEvent) * [CollectFailed](classes/events_events.CollectFailed) - * [ComputationFailed](classes/events_events.ComputationFailed) - * [ComputationFinished](classes/events_events.ComputationFinished) - * [ComputationStarted](classes/events_events.ComputationStarted) * [DebitNoteAccepted](classes/events_events.DebitNoteAccepted) * [DebitNoteReceived](classes/events_events.DebitNoteReceived) * [DemandFailed](classes/events_events.DemandFailed) @@ -45,18 +42,17 @@ type: JS API Reference * [ProposalResponded](classes/events_events.ProposalResponded) * [ScriptExecuted](classes/events_events.ScriptExecuted) * [ScriptSent](classes/events_events.ScriptSent) - * [TaskFinished](classes/events_events.TaskFinished) - * [TaskRedone](classes/events_events.TaskRedone) - * [TaskRejected](classes/events_events.TaskRejected) - * [TaskStarted](classes/events_events.TaskStarted) - * [TaskExecutor](classes/executor_executor.TaskExecutor) - * [GolemNetwork](classes/golem_network_golem_network.GolemNetwork) - * [Job](classes/job_job.Job) + * [GolemNetwork](classes/experimental_golem_network_golem_network.GolemNetwork) + * [Job](classes/experimental_job_job.Job) + * [GolemReputationError](classes/experimental_reputation_error.GolemReputationError) + * [ReputationSystem](classes/experimental_reputation_system.ReputationSystem) + * [GvmiServer](classes/gvmi_gvmiServer.GvmiServer) * [GolemMarketError](classes/market_error.GolemMarketError) * [Proposal](classes/market_proposal.Proposal) * [ProposalsBatch](classes/market_proposals_batch.ProposalsBatch) * [GolemNetworkError](classes/network_error.GolemNetworkError) * [NetworkNode](classes/network_node.NetworkNode) + * [TcpProxy](classes/network_tcpProxy.TcpProxy) * [Package](classes/package_package.Package) * [InvoiceProcessor](classes/payment_InvoiceProcessor.InvoiceProcessor) * [AgreementPaymentProcess](classes/payment_agreement_payment_process.AgreementPaymentProcess) @@ -68,66 +64,84 @@ type: JS API Reference * [GftpStorageProvider](classes/storage_gftp.GftpStorageProvider) * [NullStorageProvider](classes/storage_null.NullStorageProvider) * [WebSocketBrowserStorageProvider](classes/storage_ws_browser.WebSocketBrowserStorageProvider) - * [Batch](classes/task_batch.Batch) - * [GolemWorkError](classes/task_error.GolemWorkError) - * [RemoteProcess](classes/task_process.RemoteProcess) - * [Task](classes/task_task.Task) - * [WorkContext](classes/task_work.WorkContext) - * [RequestorApi](classes/utils_yagna_activity.RequestorApi) - * [RequestorApi](classes/utils_yagna_gsb.RequestorApi) - * [RequestorApi](classes/utils_yagna_identity.RequestorApi) - * [Yagna](classes/utils_yagna_yagna.Yagna) + * [YagnaApi](classes/utils_yagna_yagnaApi.YagnaApi) + * [Batch](classes/work_batch.Batch) + * [GolemWorkError](classes/work_error.GolemWorkError) + * [RemoteProcess](classes/work_process.RemoteProcess) + * [WorkContext](classes/work_work.WorkContext) * Enums * [ActivityStateEnum](enums/activity_activity.ActivityStateEnum) + * [JobState](enums/experimental_job_job.JobState) * [MarketErrorCode](enums/market_error.MarketErrorCode) * [NetworkErrorCode](enums/network_error.NetworkErrorCode) * [PaymentErrorCode](enums/payment_error.PaymentErrorCode) - * [WorkErrorCode](enums/task_error.WorkErrorCode) - * [TaskState](enums/task_task.TaskState) + * [WorkErrorCode](enums/work_error.WorkErrorCode) * Interfaces + * [ActivityEvents](interfaces/activity_activity.ActivityEvents) * [ActivityOptions](interfaces/activity_activity.ActivityOptions) * [ExeScriptRequest](interfaces/activity_activity.ExeScriptRequest) + * [ActivityFactoryEvents](interfaces/activity_factory.ActivityFactoryEvents) * [ResultData](interfaces/activity_results.ResultData) * [RuntimeEventKind](interfaces/activity_results.RuntimeEventKind) * [StreamingBatchEvent](interfaces/activity_results.StreamingBatchEvent) + * [AgreementEvents](interfaces/agreement_agreement.AgreementEvents) * [ProviderInfo](interfaces/agreement_agreement.ProviderInfo) + * [AgreementFactoryEvents](interfaces/agreement_factory.AgreementFactoryEvents) * [AgreementDTO](interfaces/agreement_service.AgreementDTO) * [AgreementServiceOptions](interfaces/agreement_service.AgreementServiceOptions) - * [TaskExecutorEventsDict](interfaces/executor_events.TaskExecutorEventsDict) - * [JobEventsDict](interfaces/job_job.JobEventsDict) + * [JobEventsDict](interfaces/experimental_job_job.JobEventsDict) + * [AgreementSelectorOption](interfaces/experimental_reputation_types.AgreementSelectorOption) + * [ProposalFilterOptions](interfaces/experimental_reputation_types.ProposalFilterOptions) + * [ReputationConfig](interfaces/experimental_reputation_types.ReputationConfig) + * [ReputationData](interfaces/experimental_reputation_types.ReputationData) + * [ReputationProviderEntry](interfaces/experimental_reputation_types.ReputationProviderEntry) + * [ReputationProviderScores](interfaces/experimental_reputation_types.ReputationProviderScores) + * [ReputationRejectedOperator](interfaces/experimental_reputation_types.ReputationRejectedOperator) + * [ReputationRejectedProvider](interfaces/experimental_reputation_types.ReputationRejectedProvider) + * [ReputationUntestedProvider](interfaces/experimental_reputation_types.ReputationUntestedProvider) * [DemandDetails](interfaces/market_demand.DemandDetails) + * [DemandEvents](interfaces/market_demand.DemandEvents) * [DemandOptions](interfaces/market_demand.DemandOptions) + * [DemandFactoryEvents](interfaces/market_factory.DemandFactoryEvents) * [ProposalDetails](interfaces/market_proposal.ProposalDetails) + * [ProposalEvents](interfaces/market_proposal.ProposalEvents) * [MarketOptions](interfaces/market_service.MarketOptions) * [NetworkInfo](interfaces/network_network.NetworkInfo) * [PackageDetails](interfaces/package_package.PackageDetails) * [BasePaymentOptions](interfaces/payment_config.BasePaymentOptions) * [DebitNoteDTO](interfaces/payment_debit_note.DebitNoteDTO) + * [DebitNoteEvents](interfaces/payment_debit_note.DebitNoteEvents) * [InvoiceDTO](interfaces/payment_invoice.InvoiceDTO) + * [InvoiceEvents](interfaces/payment_invoice.InvoiceEvents) + * [PaymentEvents](interfaces/payment_payments.PaymentEvents) * [PaymentOptions](interfaces/payment_payments.PaymentOptions) * [PaymentOptions](interfaces/payment_service.PaymentOptions) + * [PaymentServiceEvents](interfaces/payment_service.PaymentServiceEvents) * [StorageProvider](interfaces/storage_provider.StorageProvider) * [WebSocketStorageProviderOptions](interfaces/storage_ws_browser.WebSocketStorageProviderOptions) - * [TaskServiceOptions](interfaces/task_service.TaskServiceOptions) - * [CommandOptions](interfaces/task_work.CommandOptions) - * [WorkOptions](interfaces/task_work.WorkOptions) * [Logger](interfaces/utils_logger_logger.Logger) - * [IdentityModel](interfaces/utils_yagna_identity.IdentityModel) + * [CommandOptions](interfaces/work_work.CommandOptions) + * [WorkOptions](interfaces/work_work.WorkOptions) * Modules * [activity/activity](modules/activity_activity) + * [activity/factory](modules/activity_factory) * [activity/results](modules/activity_results) * [agreement/agreement](modules/agreement_agreement) + * [agreement/factory](modules/agreement_factory) * [agreement/service](modules/agreement_service) * [agreement/strategy](modules/agreement_strategy) * [error/golem-error](modules/error_golem_error) * [events/events](modules/events_events) - * [executor/events](modules/executor_events) - * [executor/executor](modules/executor_executor) - * [golem_network/golem_network](modules/golem_network_golem_network) - * [job/job](modules/job_job) + * [experimental/golem_network/golem_network](modules/experimental_golem_network_golem_network) + * [experimental/job/job](modules/experimental_job_job) + * [experimental/reputation/error](modules/experimental_reputation_error) + * [experimental/reputation/system](modules/experimental_reputation_system) + * [experimental/reputation/types](modules/experimental_reputation_types) + * [gvmi/gvmiServer](modules/gvmi_gvmiServer) * [market/builder](modules/market_builder) * [market/demand](modules/market_demand) * [market/error](modules/market_error) + * [market/factory](modules/market_factory) * [market/helpers](modules/market_helpers) * [market/proposal](modules/market_proposal) * [market/proposals_batch](modules/market_proposals_batch) @@ -137,6 +151,7 @@ type: JS API Reference * [network/network](modules/network_network) * [network/node](modules/network_node) * [network/service](modules/network_service) + * [network/tcpProxy](modules/network_tcpProxy) * [package/package](modules/package_package) * [payment/InvoiceProcessor](modules/payment_InvoiceProcessor) * [payment/agreement_payment_process](modules/payment_agreement_payment_process) @@ -152,21 +167,15 @@ type: JS API Reference * [storage/null](modules/storage_null) * [storage/provider](modules/storage_provider) * [storage/ws-browser](modules/storage_ws_browser) - * [task/batch](modules/task_batch) - * [task/error](modules/task_error) - * [task/process](modules/task_process) - * [task/service](modules/task_service) - * [task/task](modules/task_task) - * [task/work](modules/task_work) * [utils/env](modules/utils_env) * [utils/logger/defaultLogger](modules/utils_logger_defaultLogger) - * [utils/logger/jsonLogger](modules/utils_logger_jsonLogger) * [utils/logger/logger](modules/utils_logger_logger) * [utils/logger/nullLogger](modules/utils_logger_nullLogger) - * [utils/logger/pinoLogger](modules/utils_logger_pinoLogger) * [utils/runtimeContextChecker](modules/utils_runtimeContextChecker) + * [utils/timeout](modules/utils_timeout) * [utils/types](modules/utils_types) - * [utils/yagna/activity](modules/utils_yagna_activity) - * [utils/yagna/gsb](modules/utils_yagna_gsb) - * [utils/yagna/identity](modules/utils_yagna_identity) - * [utils/yagna/yagna](modules/utils_yagna_yagna) \ No newline at end of file + * [utils/yagna/yagnaApi](modules/utils_yagna_yagnaApi) + * [work/batch](modules/work_batch) + * [work/error](modules/work_error) + * [work/process](modules/work_process) + * [work/work](modules/work_work) \ No newline at end of file