Class: Job<Output>

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.

• constructor

• events
• results
• error
• state
• id

• isRunning
• startWork
• cancel
• waitForResult

• new Job<Output>(id, yagnaApi, defaultOptions?): Job<Output>

Create a new Job instance. It is recommended to use GolemNetwork to create jobs instead of using this constructor directly.

Job<Output>

src/job/job.ts:76

• Readonly events: EventEmitter<JobEventsDict, any>

src/job/job.ts:62

• results: undefined | Output

src/job/job.ts:65

• error: undefined | Error

src/job/job.ts:66

• state: TaskState = JobState.New

src/job/job.ts:67

• Readonly id: string

src/job/job.ts:77

▸ isRunning(): boolean

boolean

src/job/job.ts:82

▸ 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 event emitter to listen for state changes. You can also use Job.waitForResult to wait for the job to finish and get the results. If you want to cancel the job, use 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.

void

src/job/job.ts:98

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

Promise<void>

src/job/job.ts:235

▸ waitForResult(): Promise<unknown>

Wait for the job to finish and return the results. Throws an error if the job was not started.

Promise<unknown>

src/job/job.ts:249