For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10

Function: runWorkerLoop()

Opt-In Subpath

The Effect API is an opt-in subpath (@camunda8/orchestration-cluster-api/effect) and requires the optional effect peer dependency. The main . entry stays Promise-based and pulls in zero Effect at runtime.

function runWorkerLoop<A, R>(
config
): Effect<void, DomainError, CamundaEffect | R>;

The worker loop: drains activateJobsStream, running the handler for each job with bounded concurrency (the backpressure knob), and acknowledging via completeJob/failJob/throwJobError per the handler's typed outcome.

Type Parameters​

A​

A extends CompleteVars

R​

R = never

Parameters​

config​

EffectWorkerConfig<A, R>

Returns​

Effect<void, DomainError, CamundaEffect | R>