Class: TaskExecutor

executor.TaskExecutor

A high-level module for defining and executing tasks in the golem network

• constructor

• events
• glm

• create
• init
• shutdown
• getStats
• run
• cancel

• new TaskExecutor(options)

Create a new TaskExecutor object.

executor.ts:221

• Readonly events: EventEmitter<ExecutorEvents, any>

executor.ts:143

• Readonly glm: GolemNetwork

This object is the main entry-point to the basic golem-js api. Allows you to listen to events from core golem-js modules such as market, payment, etc. Provides full access to the low-level api intended for more advanced users

executor.ts:149

▸ Static create(options): Promise<TaskExecutor>

Create a new Task Executor

Promise<TaskExecutor>

TaskExecutor

Description

Factory Method that create and initialize an instance of the TaskExecutor

Example

**Simple usage of Task Executor**

The executor can be created by passing appropriate initial parameters such as market, payment, payment etc.

Example

Usage of Task Executor with custom parameters

const executor = await TaskExecutor.create({
  logger: pinoPrettyLogger({ level: "info" }),
  demand: {
    workload: {
      imageTag: "golem/alpine:latest",
    },
  },
  market: {
    rentHours: 0.5,
    pricing: {
      model: "linear",
      maxStartPrice: 0.5,
      maxCpuPerHourPrice: 1.0,
      maxEnvPerHourPrice: 0.5,
    },
  },
});

executor.ts:210

▸ init(): Promise<void>

Initialize executor Method responsible for connecting to the golem network and initiating all required services.

Promise<void>

executor.ts:238

▸ 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.

Promise<void>

executor.ts:286

▸ getStats(): Object

Object

executor.ts:315

▸ run<OutputType>(taskFunction, options?): Promise<OutputType>

Run task - allows to execute a single taskFunction function on the Golem network with a single provider.

Promise<OutputType>

result of task computation

Example

await executor.run(async (exe) => console.log((await exe.run("echo 'Hello World'")).stdout));

executor.ts:333

▸ cancel(reason): Promise<void>

Promise<void>

executor.ts:374