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

Interface: CamundaEffectWorkerHandle

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.

A handle to a running Effect worker.

Properties​

interrupt​

readonly interrupt: Effect<void>;

Interrupt the worker (also happens automatically when the owning scope closes).

join​

readonly join: Effect<void, DomainError>;

Completes when the worker loop ends (only on a fatal, non-retryable activation error).

type​

readonly type: string;

The job type this worker activates.